Crear PBX #

Crea un nuevo PbxConnectionProfile asignado a un inquilino del cliente.

POST /v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs

Ejemplo #

Esta solicitud creará un nuevo ~.pbx.kazoo.name.~ PbxConnectionProfile con los siguientes detalles:

Cliente: dentro del inquilino del cliente con el identificador de {CUSTOMER_TENANT_ID}
Nombre: "Clientes ~.pbx.kazoo.name.~ Pbx"
Descanso del anfitrión: "https://rest.example.com"
Host Websocket: "wss://ws.example.com"
ID de cuenta: "12345"
API Clave: "ABCDEF"

Pedir #

POST <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs> HTTP/1.1
Tipo de contenido: application/json
accept-charges: true
Autorización: portador {TOKEN}
Conexión: keep-alive
{
    "name": "Clientes ~.pbx.kazoo.name.~ Pbx",
 	"hostRest": "<https://rest.example.com">,
    "hostWebsocket": "wss://ws.example.com",
    "accountId": "12345",
    "apiKey": "ABCDEF",
    "\_type": "KazooPbxConnectionProfile"
}

Respuesta #

HTTP/1.1 201 Creado
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
Ubicación: <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}>
{
	"datos": {
 		"hostRest": "<https://rest.example.com">,
        "hostWebsocket": "wss://ws.example.com",
        "accountId": "12345",
        "apiKey": "ABCDEF",
        "\_type": "KazooPbxConnectionProfile",
        "id": "{PBX_ID}",
        "name":" Clientes ~.pbx.kazoo.name.~ Pbx",
        "tenantId": "{CUSTOMER_TENANT_ID}",
        "countryCode": "US",
        "habilitado": falso
	},
	"status": "éxito",
	"timestamp": "2019-11-29T16:03:23.9251680Z"
}

Ejemplo #

Esta solicitud creará un nuevo 3CX PbxConnectionProfile con los siguientes detalles:

Pedir #

POST <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs> HTTP/1.1
Tipo de contenido: application/json
accept-charges: true
Autorización: portador {TOKEN}
Conexión: keep-alive
{
    "\_type": "ThreeCxConnectionProfile",
    "nombre": "3CX Conexión",
    "licenseKey": "licenseKey-licenseKey-licenseKey",
    "nombre de usuario": "nombre de usuario-nombre de usuario-nombre de usuario",
    "password": "contraseña contraseña contraseña",
    "enableRecordingArchive": "verdadero",
    "recordingArchiveFrequency": "00:20:00"
}

Respuesta #

HTTP/1.1 201 Creado
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
Ubicación: <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}>
{
	"datos": {
 		 "\_type": "ThreeCxConnectionProfile",
        "nombre": "3CX Conexión",
        "licenseKey": "licenseKey-licenseKey-licenseKey",
        "nombre de usuario": "nombre de usuario-nombre de usuario-nombre de usuario",
        "password": "contraseña contraseña contraseña",
        "enableRecordingArchive": "verdadero",
        "recordingArchiveFrequency": "00:20:00"
	},
	"status": "éxito",
	"timestamp": "2019-11-29T16:03:23.9251680Z"
}

Errores #

Desautorizado #

Cuando el token no se proporciona, no es válido o ha caducado

HTTP/1.1 401 No autorizado

Mala solicitud #

Cuando el identificador de inquilino proporcionado no está en el formato correcto

HTTP/1.1 400 Solicitud incorrecta
Fecha: Thu, 06 Feb 2020 12:45:27 GMT
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: 149
{
	"error": 400,
	"message": "El valor '<tenant id>' no es válido.",
	"status": "error",
	"timestamp": "2020-02-06T12:45:27.5903465Z"
}

No encontrado #

Cuando no hay clientes que tengan un identificador de inquilino coincidente

HTTP/1.1 404 No encontrado
Fecha: Thu, 06 Feb 2020 12:46:58 GMT
Tipo de contenido: application/json; charset=utf-8
Contenido-Longitud: 95
{
	"error": 404,
	"message": "No encontrado",
	"status": "error",
	"marca de tiempo": "2020-02-06T12:46:58.7669535Z"
}