Criar PBX

Criar PBX #

Cria um novo PbxConnectionProfile atribuído a um locatário Customer.

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

Exemplo #

Essa solicitação criará um novo ~.pbx.kazoo.name.~ PbxConnectionProfile com os seguintes detalhes:

  • Cliente: dentro do locatário do cliente com a ID de {CUSTOMER_TENANT_ID}
  • Nome: "Clientes ~.pbx.kazoo.name.~ PBX"
  • Descanso do anfitrião: "https://rest.example.com"
  • Websocket do host: "wss://ws.example.com"
  • ID da conta: "12345"
  • API Chave: "ABCDEF"

Pedir # 

POST <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs> HTTP/1.1
Tipo de conteúdo: application/json
aceitar-encargos: verdadeiro
Autorização: Portador {TOKEN}
Conexão: keep-alive
{
    "name": "Clientes ~.pbx.kazoo.name.~ Pabx",
 	"hostRest": "<https://rest.example.com">,
    "hostWebsocket": "wss://ws.example.com",
    "accountId": "12345",
    "apiKey": "ABCDEF",
    "\_type": "KazooPbxConnectionProfile"
}

Resposta # 

HTTP/1.1 201 Criado
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: xx
Localização: <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}>
{
	"dados": {
 		"hostRest": "<https://rest.example.com">,
        "hostWebsocket": "wss://ws.example.com",
        "accountId": "12345",
        "apiKey": "ABCDEF",
        "\_type": "KazooPbxConnectionProfile",
        "id": "{PBX_ID}",
        "name":" Clientes ~.pbx.kazoo.name.~ Pabx",
        "tenantId": "{CUSTOMER_TENANT_ID}",
        "countryCode": "US",
        "ativado": falso
	},
	"status": "sucesso",
	"carimbo de data/hora": "2019-11-29T16:03:23.9251680Z"
}

Exemplo #

Essa solicitação criará um novo 3CX PbxConnectionProfile com os seguintes detalhes:

Pedir # 

POST <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs> HTTP/1.1
Tipo de conteúdo: application/json
aceitar-encargos: verdadeiro
Autorização: Portador {TOKEN}
Conexão: keep-alive
{
    "\_type": "ThreeCxConnectionProfile",
    "nome": "3CX Conexão",
    "licenseKey": "licenseKey-licenseKey-licenseKey",
    "username": "username-username-username",
    "password": "senha senha senha",
    "enableRecordingArchive": "verdadeiro",
    "recordingArchiveFrequency": "00:20:00"
}

Resposta # 

HTTP/1.1 201 Criado
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: xx
Localização: <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}>
{
	"dados": {
 		 "\_type": "ThreeCxConnectionProfile",
        "nome": "3CX Conexão",
        "licenseKey": "licenseKey-licenseKey-licenseKey",
        "username": "username-username-username",
        "password": "senha senha senha",
        "enableRecordingArchive": "verdadeiro",
        "recordingArchiveFrequency": "00:20:00"
	},
	"status": "sucesso",
	"carimbo de data/hora": "2019-11-29T16:03:23.9251680Z"
}

Erros #

Desautorizado #

Quando o token não é fornecido, é inválido ou expirado 

HTTP/1.1 401 Não autorizado

Solicitação incorreta #

Quando a ID do locatário fornecida não está no formato correto 

HTTP/1.1 400 Solicitação incorreta
Data: Qui, 06 de fevereiro de 2020 12:45:27 GMT
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: 149
{
	"erro": 400,
	"message": "O valor '<tenant id>' não é válido.",
	"status": "erro",
	"carimbo de data/hora": "2020-02-06T12:45:27.5903465Z"
}

Não encontrado #

Quando não há clientes que tenham uma ID de locatário correspondente 

HTTP/1.1 404 Não encontrado
Data: Qui, 06 de fevereiro de 2020 12:46:58 GMT
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: 95
{
	"erro": 404,
	"message": "Não encontrado",
	"status": "erro",
	"carimbo de data/hora": "2020-02-06T12:46:58.7669535Z"
}