Webhooks

A través de este punto final, puede crear, ver y eliminar webhooks. Alternativamente, puede gestionar sus webhooks en la aplicación web en la sección Desarrollador.

GET/api/hooks

Leer webhooks

Consulte los webhooks activos de su cuenta.

Solicitud

GET

/api/hooks

curl -G "https://gateway.seven.io/api/hooks" \
    -H "X-Api-Key: SU_CLAVE_API"

Respuesta

{
  "success": true,
  "code": null,
  "hooks": [
    {
      "id": "410",
      "target_url": "https://acme.inc/v1/webhooks",
      "headers": "",
      "event_type": "sms_mo",
      "event_filter": "49157123456789",
      "request_method": "GET",
      "enabled": true,
      "created": "2021-03-01 11:19:08"
    },
    {
      "id": "1277",
      "target_url": "https://hooks.seven.io/hook",
      "headers": "Authorization: Basic dXNlcjpwYXNz",
      "event_type": "all",
      "event_filter": null,
      "request_method": "JSON",
      "enabled": false,
      "created": "2021-12-30 13:33:02"
    }
  ]
}

POST/api/hooks

Registrar webhook

Parámetros

Name
target_url
Type
string
Description
Dirección de destino de su webhook
Name
headers
Type
string
Description
Encabezados HTTP que desea enviar con el webhook. Por ejemplo, para autenticación. Varios encabezados se separan por \n.
Name
event_type
Type
enum
Description
Tipo de evento para el cual desea recibir un webhook.
Mostrar eventos
all – Envía todos los eventos
rcs - Eventos RCS y mensajes RCS entrantes
sms_mo – Nuevo SMS entrante
dlr – Informes de estado de sus SMS
voice_call – Información sobre llamadas entrantes en Voicecalls
voice_status – Actualizaciones para Voicecalls
voice_dtmf – Señales DTMF en Voicecalls
tracking – Clics o vistas del Performance Tracking
Name
event_filter
Type
string
Optional
Optional
Description
Opcional. Envía el webhook solo si el filtro coincide. Por ejemplo, para diferentes webhooks en diferentes números entrantes.
Name
request_method
Type
enum
Optional
Optional
Description
Método de solicitud en el que desea recibir el webhook.
POST - Los datos se envían como una solicitud HTTP POST como application/x-www-form-urlencoded (por defecto) GET - Los datos se envían como parámetros HTTP GET JSON - Los datos se envían por HTTP POST como carga JSON

Anfrage

POST

/api/hooks

curl -X POST "https://gateway.seven.io/api/hooks" \
    -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
    -d "target_url=https://acme.inc/webhook/" \
    -d "event_type=all"

Antwort

{
    "success": true,
    "code": null,
    "id": 12345,
    "error_message": null
}

DELETE/api/hooks

Eliminar Webhook

Llame a la API con los mismos parámetros con los que se creó el webhook (target_url, event_type, request_method) para eliminarlo. Alternativamente, puede eliminar un webhook directamente a través de su respectivo ID. Para ello, proporcione el parámetro id.

Recibirá la misma respuesta que al crear el webhook.

Parámetros (Eliminar por ID)

Name
id
Type
integer
Description
El ID del webhook que desea eliminar.

Anfrage

DELETE

/api/hooks

curl -X DELETE "https://gateway.seven.io/api/hooks" \
    -H "X-Api-Key: SU_CLAVE_API" \
    -d "id=123456"

Antwort

{
    "success": true,
    "code": null,
    "id": 12345,
    "error_message": null
}