Documentação para integração aos serviços da plataforma iSix Play Api.
O serviço utiliza a arquitetura REST (Representational State Transfer), que utiliza os verbos HTTP (GET, POST, PUT e DELETE) para executar as operações. A API suporta o formato JSON, definido através do cabeçalho HTTP "content-type":
content-type:application/json
O protocolo padrão para comunicação com as APIs REST é HTTP 1.1 e a codificação de caracteres é UTF-8.
Todas as requisições devem conter o cabeçalho de autorização HTTP com os dados de acesso (login e senha) referentes a um usuário ativo no iSix Play.
Os dados de acesso, devem estar codificados em base 64 com o formato LOGIN:SENHA
Exemplo: se o login é "0123ABCDEF" e a senha é "A1B2C3D4E5", o cabeçalho de autorização deve ser o seguinte:
Authorization: Basic
Authorization: Basic MDEyM0FCQ0RFRjpBMUIyQzNENEU1
Exemplo de cabeçalho de requisição:
POST https://api.isixdigital.com.br/api/Grupo HTTP/1.1
Accept-Encoding: gzip,deflate
Accept-language: pt-br
Content-Type: application/json
Content-Length: 771
Host: api.isixdigital.com.br
Connection: Keep-Alive
Authorization: Basic MDEyM0FCQ0RFRjpBMUIyQzNENEU1
O corpo da requisição é definido conforme o tipo de serviço solicitado.
A resposta do serviço contém um código (0 para mensagem de sucesso, 88 para mensagem de negócio e 99 para mensagem de erro), criticas e dados.
O JSON abaixo exemplifica uma resposta do serviço.
{
"cod": 0,
"criticas": [
{
"critica": "sample String 1"
},
{
"critica": "sample String 1"
}
],
"dados": {
"acordos": {...}
}
}
Instruções sobre preenchimento de objetos:
A estrutura completa que compõe o corpo das requisições de envio e retorno é descrita no tópico “Métodos“.
URL: https://api.isixdigital.com.br
Envio para o CRM do cliente os status dos disparos cadastrados no iSix Play (SMS, E-mail, RCS e Whatsapp) via Webhook
Verbo: POST
Parâmetros:
URI:
- código CRM do grupo
- código do lote de exportação
Exemplo: http://empresa.com.br/api/Disparos/123456/S7896
Body:
- JSON Array contendo os dados do status do disparo a serem importados pelo CRM do cliente
Retorno da Requisição:
- Status HTTP esperado: 200 OK
- Body: Sem conteúdo
| Parâmetro | Descrição | Tipo | Tam. | Obrig. | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| codGrupoCrm | Código do grupo associado ao subgrupo do contrato. | String | 100 | S | |||||||||||||||
| descricaoGrupo | Descrição do grupo do subgrupo associado ao contrato do disparo. | String | 100 | S | |||||||||||||||
| codSubgrupoCrm | Código do subgrupo associado ao contrato do disparo sistema CRM da empresa. | String | 100 | S | |||||||||||||||
| descricaoSubgrupo | Descrição do subgrupo associado ao contrato do disparo. | String | 100 | S | |||||||||||||||
| codContratoCrm | Código do contrato associado ao status do disparo no sistema CRM da empresa. | String | 100 | S | |||||||||||||||
| codCrmCliente | Código do cliente no sistema CRM da empresa. | String | 100 | S | |||||||||||||||
| nomeCliente | Nome do cliente associado ao contrato do disparo. | String | 100 | S | |||||||||||||||
| codDisparo | Código de identificação do disparo no iSix Play | Int32 | 10 | S | |||||||||||||||
| dataHoraDisparo | Data/hora do disparo | Datetime | 16 | S | |||||||||||||||
| tipoDisparo | Descrição do tipo de disparo. | String | 15 | S | |||||||||||||||
| servico | Descrição do serviço associado ao disparo. | String | 100 | S | |||||||||||||||
| identificadorServico | Código de identificação do disparo no serviço | Int32 | 10 | S | |||||||||||||||
| tipoContatoAcionado | Identificação do tipo de contato acionado. | String | 20 | S | |||||||||||||||
| codCrmReferencia | Código da referência no sistema CRM da empresa. | String | 100 | N | |||||||||||||||
| nomeReferencia | Nome da referência do cliente associado ao contato do acionamento disparo. | String | 300 | N | |||||||||||||||
| contatoAcionado | Contato que foi acionado no disparo (telefone, e-mail, etc.) | String | 100 | S | |||||||||||||||
| codStatusDisparo | Código do status no sistema iSix Play. | Int32 | 10 | S | |||||||||||||||
| dataHoraDisparo | Data/hora do disparo. | Datetime | 16 | S | |||||||||||||||
| identificadorStatusDisparo |
Identificador do status do disparo. É composto de 3 caracteres, 1 letra e 2 dígitos numéricos
|
String | 3 | S | |||||||||||||||
| descricaoStatusDisparo | Descrição do status do disparo. | String | 100 | S | |||||||||||||||
| mensagemDisparo | Mensagem enviada no disparo. | String | - | N |
[
{
"codCrmGrupo":"5857",
"descricaoGrupo":"Empresa.com",
"codCrmSubgrupo":"2004571",
"descricaoSubgrupo":"CART26",
"codCrmContrato":"125486985",
"codCrmCliente":"26689782",
"nomeCliente":"CLIENTE VIP",
"codDisparo":8558212,
"dataHoraDisparo":"2025-01-01T08:34:54.513",
"tipoDisparo":"SMS",
"servico":"NEO SMS",
"identificadorServico":"52282921",
"tipoContatoAcionado":"Telefone Cliente",
"codCrmReferencia":null,
"nomeReferencia":null,
"contatoAcionado":"(01)12345-9876",
"codStatusDisparo":172266333,
"dataHoraStatusDisparo":"2025-01-01T08:35:55.233",
"identificadorStatusDisparo":"S01",
"descricaoStatusDisparo":"Sem Retorno"
"mensagemDisparo":"CLIENTE VIP, evite protesto em cartorio do seu debito com a Empresa.Com. Ligue 08001234567 ou WhatsApp http://wa.me/1234567890123"
}
]