Webhook
POST https://{API URL}/api/integrations/UpdateWebHook?url={url}
* = Required
| Key | Description |
|---|---|
| clientId* | DM ID for the client you wish to send the number for |
| Key | Description |
|---|---|
| url | a valid url string or empty to remove webhook |
204 No Content - Successfully added/updated/removed
400 Bad Request - Validation Errors
{
"errors": {
"WebHookUrl": [
"string is not in valid URL format"
]
}
}
In order to use web hooks you will need to register your url with Dynamic Messaging. This is can be done by emailing us and letting us which URLs you will be using for i.e. Development and Live
When a call has been attempted a event will be fired sending information about the call to the url provided.
{
"webHookType": 0,
"data":{
"clientId":0,
"outCome":0,
"stage":0,
"startTime":"2023-06-27T03:04:01.374Z",
"endTime":"2023-06-27T03:04:01.374Z",
"userInput":"string",
"campaignId":"",
"phoneNumber":""
}
}
| Description | Value |
|---|---|
Answered |
1 |
Unobtainable |
2 |
Busy |
3 |
Answerphone Message Not Left |
4 |
Answerphone Message Left |
5 |
No Answer |
6 |
Overflow |
7 |
Out Of Time |
8 |
Fax |
9 |
Unknown |
10 |
Excluded Number |
11 |
No Connection |
12 |
Invalid Number |
13 |
Stage
| Description | Value |
|---|---|
No Action |
0 |
Caller confirmed as right party |
1 |
Caller confirmed not right party |
2 |
Call declined |
3 |
Right party hung up |
4 |
Wrong party hung up |
5 |
Call centre hung up |
6 |
Right party transfer requested |
7 |
Right party transfer accepted |
8 |
Excluded |
9 |
Answered |
10 |
Answerphone Message Not Left |
11 |
Answerphone Message Left |
12 |
Opt in |
13 |
Opt out |
14 |
Wrong party transfer requested |
15 |
Call transferred to call centre |
16 |
Transferred to payment line |
17 |
Caller requested call back |
18 |
Wrong party transfer accepted |
19 |
Call dropped |
20 |
{
"webHookType": 1,
"data":{
"clientId":0,
"Id":0,
"phoneNumberId":"",
"phoneNumber":"",
"parts":0,
"dateCreated":"2023-06-27T03:04:01.374Z",
"lastUpdated":"2023-06-27T03:04:01.374Z",
"price": 0.0,
"statusCode":0
}
}
| Value | Description |
|---|---|
| 0 | Sent |
| 1 | Delivered |
| 2 | Accepted |
| 3 | Expired |
| 4 | Deleted |
| 5 | Undeliverable |
| 6 | Unknown |
| 7 | Rejected |
| 8,9,10 | Other |
| 34 | RejectedInvalidRecipient |
| 1000 | FailedInsufficientCredit |