ReceitaNet - Telefonia - API Documentation
version 1
baseUri https://sistema.receitanet.net/api/novo/telefonia
protocols HTTPS
mediaType application/json
/
Criar uma nova ligação, armazene o idTelefonia para uso posterior
/ post
POST: / (secured)
Query Parameters
token
token para autenticação, solicitar com o suporte
| Property | Value |
|---|---|
| required | true |
| type | string |
app
nome da aplicação
| Property | Value |
|---|---|
| required | true |
| type | string |
| oneOf | ura, telefonia |
number
número do cliente no formato 11988887777 ou 1199998888
| Property | Value |
|---|---|
| required | true |
| type | int |
tipo
tipo da chamada, por padrão é configurado as seguintes (1: manutenção, 2: instalação, 4: retiradas de equipamentos e 5: financeiro), podendo ser adicionado novas no em Cadastros Diversos / Telefonia (pegar a numeração na coluna Cód. na listagem no ReceitaNet)
| Property | Value |
|---|---|
| required | true |
| type | int |
descricao
descrição do atendimento ou caminho percorrido pelo cliente na URA.
| Property | Value |
|---|---|
| required | true |
| type | string |
idCliente
ID do cliente, informe nulo caso a ligação não seja identificada.
| Property | Value |
|---|---|
| required | true |
| type | int |
Possible Responses
200
400
falha na validação dos parametros informado, verifique o retorno
401
não autenticado
/ post
CURL EXAMPLE
curl -X POST "https://sistema.receitanet.net/api/novo/telefonia/" \
-d @request_bodyRESPONSE BODY
200
{
"success": true,
"idTelefonia": 5000
}Type
object/ramal
Vincular um ramal a ligação
/ramal post
POST: /ramal (secured)
Query Parameters
token
token para autenticação, solicitar com o suporte
| Property | Value |
|---|---|
| required | true |
| type | string |
app
nome da aplicação
| Property | Value |
|---|---|
| required | true |
| type | string |
| oneOf | ura, telefonia |
idTelefonia
ID da Telefonia
| Property | Value |
|---|---|
| required | true |
| type | string |
ramal
identificação do ramal, no formato SIP/9000 ou 9000
| Property | Value |
|---|---|
| required | true |
| type | string |
Possible Responses
200
400
falha na validação dos parametros informado, verifique o retorno
401
não autenticado
/ramal post
CURL EXAMPLE
curl -X POST "https://sistema.receitanet.net/api/novo/telefonia/ramal" \
-d @request_bodyRESPONSE BODY
200
{
"success": true
}Type
object/desliga
Finalizar a ligação
/desliga post
POST: /desliga (secured)
Query Parameters
token
token para autenticação, solicitar com o suporte
| Property | Value |
|---|---|
| required | true |
| type | string |
app
nome da aplicação
| Property | Value |
|---|---|
| required | true |
| type | string |
| oneOf | ura, telefonia |
idTelefonia
ID da Telefonia
| Property | Value |
|---|---|
| required | true |
| type | string |
url_gravacao
URL da gravação
| Property | Value |
|---|---|
| required | false |
| type | string |
Possible Responses
200
400
falha na validação dos parametros informado, verifique o retorno
401
não autenticado
/desliga post
CURL EXAMPLE
curl -X POST "https://sistema.receitanet.net/api/novo/telefonia/desliga" \
-d @request_bodyRESPONSE BODY
200
{
"success": true
}Type
object