Trigger a Twilio credit alert for a workspace

Internal endpoint used by background SMS senders when Twilio rejects an outbound message for an account credit or suspension issue.

POST

https://api.channelautomation.com/api/twilio/credit-alert

Header parameters

X-Workspace-Id
string
required
Workspace ID for data isolation

Request body JSON required

workspaceId
optional
string
contactId
optional
string
errorCode
optional
string
errorMessage
optional
string
recipient
optional
string
sender
optional
string
twilioSid
optional
string
source
optional
string

Returns

200

Alert evaluated.

400

Workspace ID is required.

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean

Trigger a Twilio credit alert for a workspace

curl --request POST \
  --url https://api.channelautomation.com/api/twilio/credit-alert \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-Id: 15213' \
  --data '
{
  "workspaceId": "string",
  "contactId": "string",
  "errorCode": "string",
  "errorMessage": "string",
  "recipient": "string",
  "sender": "string",
  "twilioSid": "string",
  "source": "string"
}
'

const url = 'https://api.channelautomation.com/api/twilio/credit-alert';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', 'X-Workspace-Id': '15213'},
  body: JSON.stringify({
    workspaceId: 'string',
    contactId: 'string',
    errorCode: 'string',
    errorMessage: 'string',
    recipient: 'string',
    sender: 'string',
    twilioSid: 'string',
    source: 'string'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/twilio/credit-alert"

payload = {
    "workspaceId": "string",
    "contactId": "string",
    "errorCode": "string",
    "errorMessage": "string",
    "recipient": "string",
    "sender": "string",
    "twilioSid": "string",
    "source": "string"
}
headers = {
    "Content-Type": "application/json",
    "X-Workspace-Id": "15213"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "error": "Internal server error",
  "details": "string",
  "success": false
}