Documentación API

Documentación API

Descripción General

Obteniendo los valores de API_KEY_TOKEN

Obteniendo los valores de ACCOUNT_ID y CAMPAIGN_ID

Agregar número a una campaña dinámica

Agregar números con valores de variables a una campaña dinámica

Subir archivo CSV con nuevos números para una campaña dinámica

Descripción General

SIP Caller ofrece una API REST que permite a los clientes realizar diferentes operaciones en su cuenta de SIP Caller desde programas externos. De esta manera, se pueden desarrollar muchas integraciones personalizadas útiles entre SIP Caller y otros sistemas.

Obteniendo los valores de API_KEY_TOKEN

Para poder utilizar la API REST, un cliente de SIP Caller primero debe crear una API Key, como se explica en esta sección, para obtener un API_KEY_TOKEN que se utilizará en los siguientes ejemplos para autenticar llamadas a la API REST de SIP Caller desde un programa externo.

Obteniendo los valores de ACCOUNT_ID y CAMPAIGN_ID

El valor ACCOUNT_ID del cliente de SIP Caller, que se utilizará en los siguientes ejemplos, se puede obtener desde la consola web, como se muestra a continuación:

El valor CAMPAIGN_ID de SIP Caller, que se utilizará en los siguientes ejemplos, también se puede obtener desde la consola web, como se muestra a continuación:

Agregar número a una campaña dinámica

El siguiente ejemplo muestra cómo agregar un nuevo número a una campaña dinámica que ya está activa:

curl \

--header 'Content-Type: application/json' \

--header 'Authorization: Bearer API_KEY_TOKEN' \

--request POST \

--data-raw '{"number": "+18005551234"}' \

'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers'

Agregar números con valores de variables a una campaña dinámica

El siguiente ejemplo muestra cómo agregar un nuevo número a una campaña dinámica que ya está activa, incluidos valores de variables que pueden ser utilizados por el flujo de llamada de la campaña:

curl \

--header 'Content-Type: application/json' \

--header 'Authorization: Bearer API_KEY_TOKEN' \

--request POST \

--data-raw '{"number": "+18005551234", "varValues": ["John", "199"]}' \

'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers'

Subir archivo CSV con nuevos números para una campaña dinámica

El siguiente ejemplo muestra cómo cargar un archivo CSV (valores separados por comas) con varios números a una campaña dinámica que ya está activa.

En primer lugar, se debe preparar un archivo CSV que contenga los nuevos números que se agregarán a la campaña. A continuación, se muestra un ejemplo de un archivo CSV con 5 números y sus valores de variable correspondientes:

5550001,John,199

5550002,Mary,299

5550003,Susan,149

5550004,James,300

5550005,Walter,42

En segundo lugar, el archivo CSV preparado se puede cargar en SIP Caller con el siguiente comando:

curl \

--header 'Authorization: Bearer API_KEY_TOKEN' \

--form "file=@campaign-numbers.csv" \

'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers/upload

?firstRowIsHeader=false

&varCount=2'