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.
Header
Identificador | Valor |
---|---|
Content-type | application/json |
Accept | application/json |
Authorization | Token de autenticação |
Body
Parâmetro | Descrição | Tipo | Exemplos |
---|---|---|---|
QueueId | Identificador da fila | Int | 1 |
PersonalData.Name | Nome do usuário | String | "João da Silva" |
PersonalData.CPF | CPF do usuário | String | "12345678901" |
PersonalData.DateOfBirth | Data de nascimento | String (date-time) | "1990-01-01T00:00:00Z" |
PersonalData.Cellphone | Celular | String | "(11) 91234-5678" |
PersonalData.Email | String | "[email protected]" | |
ContractData.Value | Valor do contrato | Decimal | 1500.50 |
ContractData.Installment | Quantidade de parcelas | Int | 12 |
ContractData.Date | Data do contrato | String (date-time) | "2025-04-23T13:25:17.156Z" |
Details[].Key | Chave adicional | String | "Canal" |
Details[].Value | Valor adicional | String | "WhatsApp" |
Details[].ValueKind | Tipo de valor | String | "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âmetro | Descrição | Tipo | Exemplos |
---|---|---|---|
CallId | Id da chamada | int | 10 |
ClientLink | Link do cliente | String | "https://link-da-chamada" |
Exemplo
{
"CallId": 0,
"ClientLink": "https://link-da-chamada"
}
Status Code 400
Erro na requisição
Parâmetro | Descrição | Tipo | Exemplos |
---|---|---|---|
Status | Status da requisição | OK = 0, ERROR = 1 | 1 |
Messages | Descrição dos erros | String[] | "Messages": [] |
Status Code 401
Não autorizado
Parâmetro | Descrição | Tipo | Exemplos |
---|---|---|---|
Status | Status da requisição | OK = 0, ERROR = 1 | 1 |
Messages | Descrição dos erros | String[] | "Messages": [] |
Exemplo
{
"Status": "1",
"Messages": [
"string"
]
}