Endpoints da lista de não ligar (DNC) da empresa

A lista de DNC (do not call) da empresa permite bloquear chamadas manuais diretas e chamadas programadas e de saída criadas pela API Apps.

A API Apps da Contact Center AI Platform (CCAI Platform) oferece estes três endpoints para DNC:

Adicionar números de telefone à lista de DNC

Parâmetro Obrigatório Tipo de dados Definição
contatos TRUE Contatos de matriz Uma matriz de contatos. Cada contato tem um atributo `phone_number` e um atributo `expires_at` opcional

Endpoint:

Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc

Cabeçalhos:

Chave Valor Descrição
Content-Type aplicativo/json

Corpo:

{
    "contacts": [
        {
            "phone_number": "+1-7187309219",
            "expires_at": "2022-10-29 00:00:00 UTC"
        },
        {
            "phone_number": "+1-(358)-213-1634"
        }
    ]
}

Exemplo de solicitação e respostas

As seções a seguir mostram exemplos de solicitações para o endpoint.

Adicionar alguns contatos à lista de DNC

Este exemplo mostra a adição de contatos à lista de DNC.

Solicitação

Cabeçalhos:

Chave Valor Descrição
Content-Type aplicativo/json

Corpo:

{
    "contacts": [
        {
            "phone_number": "+1-7187309219",
            "expires_at": "2022-10-29 00:00:00 UTC"
        },
        {
            "phone_number": "+1-(358)-213-1634"
        },
        {
            "phone_number": "+1-4151113333",
            "expires_at": "2022-10-30 00:00:00 UTC"
        },
        {
            "phone_number": "+1-4151115555"
        },
        {
            "phone_number": "+1-7187309219",
            "expires_at": "2022-10-27 00:00:00 UTC"
        },
        {
            "phone_number": "sssssss"
        },
        {
            "phone_number": "911",
            "expires_at": "2023-02-05 00:00:00 UTC"
        }
    ]
}
Resposta
[
    {
        "phone_number": "+1-7187309219",
        "expires_at": "2022-10-29 00:00:00 UTC",
        "status": "created"
    },
    {
        "phone_number": "+1-(358)-213-1634",
        "status": "created"
    },
    {
        "phone_number": "+1-4151113333",
        "expires_at": "2022-10-30 00:00:00 UTC",
        "status": "updated"
    },
    {
        "phone_number": "+1-4151115555",
        "status": "updated"
    },
    {
        "phone_number": "+1-7187309219",
        "expires_at": "2022-10-27 00:00:00 UTC",
        "error": "expires_at cannot be past date/time",
        "status": "failed"
    },
    {
        "phone_number": "sssssss",
        "error": "phone_number is invalid",
        "status": "failed"
    },
    {
        "phone_number": "911",
        "expires_at": "2023-02-05 00:00:00 UTC",
        "error": "emergency phone number is not allowed",
        "status": "failed"
    }
]

Code: 200

Remover números da lista de DNC

Parâmetro Obrigatório Tipo de dados Definição
phone_numbers TRUE String de matriz Uma matriz que contém números de telefone que precisam ser removidos da lista de DNC.

Endpoint:

Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc/remove

Cabeçalhos:

Chave Valor Descrição
Content-Type aplicativo/json

Corpo:

{
    "phone_numbers": [
        "1-415-111-1111"
    ]
}

Exemplo de solicitação e respostas

As seções a seguir mostram exemplos de solicitações para o endpoint.

Remover uma lista de números de telefone

Este exemplo mostra como remover números de telefone da lista.

Solicitação

Cabeçalhos:

Chave Valor Descrição
Content-Type aplicativo/json

Corpo:

{
    "phone_numbers": [
        "1-415-111-1111",
        "1-415-222-2222",
        "1-415-333-333-3333"
    ]
}
Resposta: sucesso
{}

Código de status: 200

Verificar se um número de telefone está na lista de DNC

Parâmetro Obrigatório Tipo de dados Definição
phone_number TRUE String O número de telefone para verificar se ele está na lista de DNC

Endpoint:

Method: GET
Type: 
URL: URL: https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc/check?phone_number={phone_number}

Cabeçalhos:

Nenhum

Corpo:

Nenhum

Exemplo de solicitação e respostas

As seções a seguir mostram exemplos de solicitações para o endpoint.

Verificar se o número está na lista de DNC

Este exemplo mostra como verificar se um número de telefone está na lista de DNC.

Solicitação
Chave Valor
phone_number {PHONE_NUMBER} (Número) O número de telefone do usuário final. 
GET https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc/check?phone_number={PHONE_NUMBER}
Resposta
{
"phone_number": "1-415-111-1111",
"expired_at": "2023-08-05 22:02:36.362009 +0000"
"do_not_call": true
}

Code: 200