Extremos de la lista de números excluidos (DNC) de la empresa

La lista de DNC (no llamar) de la empresa te permite bloquear llamadas salientes directas y manuales, así como llamadas salientes y programadas creadas por la API de Apps.

La API de CCAI Platform Apps proporciona los siguientes tres endpoints para la lista de DNC:

Cómo agregar números de teléfono a la lista de DNC

Parámetro Obligatorio Tipo de datos Definición
contactos TRUE Arreglo de contactos Es un array de contactos. Cada contacto tiene un atributo `phone_number` y un atributo `expires_at` opcional.

Endpoint:

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

Encabezados:

Clave Valor Descripción
Content-Type application/json

Cuerpo:

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

Ejemplo de solicitud y respuestas

En las siguientes secciones, se proporcionan ejemplos de solicitudes al extremo.

Agrega algunos contactos a la lista de DNC

En este ejemplo, se muestra cómo agregar contactos a la lista de DNC.

Solicitud

Encabezados:

Clave Valor Descripción
Content-Type application/json

Cuerpo:

{
    "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"
        }
    ]
}
Respuesta
[
    {
        "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

Cómo quitar números de la lista de DNC

Parámetro Obligatorio Tipo de datos Definición
phone_numbers TRUE Cadena de array Es un array que contiene los números de teléfono que se deben quitar de la lista de DNC.

Endpoint:

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

Encabezados:

Clave Valor Descripción
Content-Type application/json

Cuerpo:

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

Ejemplo de solicitud y respuestas

En las siguientes secciones, se proporcionan ejemplos de solicitudes al extremo.

Cómo quitar una lista de números de teléfono

En este ejemplo, se muestra cómo quitar números de teléfono de la lista.

Solicitud

Encabezados:

Clave Valor Descripción
Content-Type application/json

Cuerpo:

{
    "phone_numbers": [
        "1-415-111-1111",
        "1-415-222-2222",
        "1-415-333-333-3333"
    ]
}
Respuesta: Éxito
{}

Código de estado: 200

Cómo verificar si un número de teléfono está en la lista de DNC

Parámetro Obligatorio Tipo de datos Definición
phone_number TRUE String Número de teléfono para verificar si está en la lista de DNC

Endpoint:

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

Encabezados:

Ninguno

Cuerpo:

Ninguno

Ejemplo de solicitud y respuestas

En las siguientes secciones, se proporcionan ejemplos de solicitudes al extremo.

Comprobar si el número está en la lista de DNC

En este ejemplo, se muestra cómo verificar si un número de teléfono está en la lista de DNC.

Solicitud
Clave Valor
phone_number {PHONE_NUMBER} (número): Es el número de teléfono del usuario final. 
GET https://{subdomain}.{domain}/apps/api/v1/outbound_dialer/dnc/check?phone_number={PHONE_NUMBER}
Respuesta
{
"phone_number": "1-415-111-1111",
"expired_at": "2023-08-05 22:02:36.362009 +0000"
"do_not_call": true
}

Code: 200