Pular para o conteúdo principal

Criar Chamada

POST [Url Ambiente]/api/Call/Create

Esse endpoint é utilizado para criar uma nova chamada no sistema, com informações pessoais, contratuais e dados adicionais.

IdentificadorValor
Content-typeapplication/json
Acceptapplication/json
AuthorizationToken de autenticação

Body

ParâmetroDescriçãoTipoExemplos
QueueIdIdentificador da filaInt1
PersonalData.NameNome do usuárioString"João da Silva"
PersonalData.CPFCPF do usuárioString"12345678901"
PersonalData.DateOfBirthData de nascimentoString (date-time)"1990-01-01T00:00:00Z"
PersonalData.CellphoneCelularString"(11) 91234-5678"
PersonalData.EmailE-mailString"[email protected]"
ContractData.ValueValor do contratoDecimal1500.50
ContractData.InstallmentQuantidade de parcelasInt12
ContractData.DateData do contratoString (date-time)"2025-04-23T13:25:17.156Z"
Details[].KeyChave adicionalString"Canal"
Details[].ValueValor adicionalString"WhatsApp"
Details[].ValueKindTipo de valorString"Texto"

Exemplo

{
"QueueId": 1,
"PersonalData": {
"Name": "João da Silva",
"CPF": "12345678901",
"DateOfBirth": "1990-01-01T00:00:00Z",
"Cellphone": "(11) 91234-5678",
"Email": "[email protected]"
},
"ContractData": {
"Value": 1500.50,
"Installment": 12,
"Date": "2025-04-23T13:25:17.156Z"
},
"Details": [
{
"Key": "Canal",
"Value": "WhatsApp",
"ValueKind": "Texto"
}
]
}

Exemplo

curl -X POST \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {seu token}' \
--data-raw '{
"QueueId": 1,
"PersonalData": {
"Name": "João da Silva",
"CPF": "12345678901",
"DateOfBirth": "1990-01-01T00:00:00Z",
"Cellphone": "(11) 91234-5678",
"Email": "[email protected]"
},
"ContractData": {
"Value": 1500.50,
"Installment": 12,
"Date": "2025-04-23T13:25:17.156Z"
},
"Details": [
{
"Key": "Canal",
"Value": "WhatsApp",
"ValueKind": "Texto"
}
]
}' 'https://api.skia.com.br/api/Call/Create'

Status Code 200

Retorno de sucesso.

ParâmetroDescriçãoTipoExemplos
CallIdId da chamadaint10
ClientLinkLink do clienteString"https://link-da-chamada"

Exemplo

{
"CallId": 0,
"ClientLink": "https://link-da-chamada"
}

Status Code 400

Erro na requisição

ParâmetroDescriçãoTipoExemplos
StatusStatus da requisiçãoOK = 0, ERROR = 11
MessagesDescrição dos errosString[]"Messages": []

Status Code 401

Não autorizado

ParâmetroDescriçãoTipoExemplos
StatusStatus da requisiçãoOK = 0, ERROR = 11
MessagesDescrição dos errosString[]"Messages": []

Exemplo

{
"Status": "1",
"Messages": [
"string"
]
}