Event notification

Numbers/

Event notification

Event notification
Webhook

Request

A notification of an event sent to your configured callback URL.

Security

Basic or OAuth2.0

Bodyapplication/json

resourceTypestring

The type of the resource.

Enum Value	Description
IMPORTED_NUMBER	Numbers imported individually or previously imported successfully via hosting orders but later updated.
HOSTING_ORDER_NUMBER	Numbers that are imported as part of a hosting order.

Example:"IMPORTED_NUMBER"

eventTypestring

The type of the event.

Enum Value	Description
PROVISIONING_TO_SMS_PLATFORM	An event that occurs when a number is linked to a Service Plan ID.
DEPROVISIONING_TO_SMS_PLATFORM	An event that occurs when a number is unlinked from a Service Plan ID.
LINK_TO_10DLC_CAMPAIGN	An event that occurs when a number is linked to a Campaign.
UNLINK_TO_10DLC_CAMPAIGN	An event that occurs when a number is unlinked from a Campaign.
HOSTING_PROCESS	An event that indicates the success or failure of a number's hosting process.
OSR_UPDATE	An event that occurs when an OSR update is performed for a number.
DELETE	An event that occurs when a number is deleted.

Example:"LINK_TO_10DLC_CAMPAIGN"

eventIdstring

The ID of the event.

Example:"abcd1234efghijklmnop567890"

timestampstring, (date-time)

The date and time when the callback was created and added to the callbacks queue in ISO 8601 format (UTC).

Example:"2023-06-06T07:45:27.785357Z"

projectIdstring

The ID of the project to which the event belongs.

Example:"abcd12ef-ab12-ab12-bc34-abcdef123456"

resourceIdstring

The unique identifier of the resource, depending on the resource type. For example, a phone number, a hosting order ID, or a brand ID.

Example:"+12345612345"

statusstring

The status of the event. For example, SUCCEEDED or FAILED.

Enum Value	Description
SUCCEEDED	The event has succeeded.
FAILED	The event has failed.

Example:"FAILED"

failureCodestring

If the status is FAILED, a failure code will be provided. For numbers provisioning to SMS platform, there won't be any extra failureCode, as the result is binary. For campaign provisioning-related failures, refer to the list for the possible values.

Enum Value	Description
CAMPAIGN_NOT_AVAILABLE	The specified campaign is not available.
EXCEEDED_10DLC_LIMIT	Exceeded the limit for 10DLC.
NUMBER_PROVISIONING_FAILED	Provisioning the number failed.
PARTNER_SERVICE_UNAVAILABLE	The third party service is unavailable.
CAMPAIGN_PENDING_ACCEPTANCE	The campaign is not yet accepted.
MNO_SHARING_ERROR	Error with MNO.
CAMPAIGN_PROVISIONING_FAILED	The campaign failed to provision.
CAMPAIGN_EXPIRED	The campaign expired.
CAMPAIGN_MNO_REJECTED	The campaign MNO was rejected.
CAMPAIGN_MNO_SUSPENDED	The campaign MNO was suspended.
CAMPAIGN_MNO_REVIEW	The campaign MNO is under review.
INSUFFICIENT_BALANCE	Not enough credit in the account.
MOCK_CAMPAIGN_NOT_ALLOWED	Provisioning not allowed for mock campaigns.
TFN_NOT_ALLOWED	Toll free numbers not allowed.
INVALID_NNID	Invalid NNID.

Example:"CAMPAIGN_NOT_AVAILABLE"

Payload

{
  "resourceType": "IMPORTED_NUMBER",
  "eventType": "LINK_TO_10DLC_CAMPAIGN",
  "eventId": "abcd1234efghijklmnop567890",
  "timestamp": "2023-06-06T07:45:27.785357Z",
  "projectId": "abcd12ef-ab12-ab12-bc34-abcdef123456",
  "resourceId": "+12345612345",
  "status": "FAILED",
  "failureCode": "CAMPAIGN_NOT_AVAILABLE"
}

Responses

200 OK

We'd love to hear from you!