Skip to content
This repository was archived by the owner on Nov 29, 2023. It is now read-only.

Commit 0ea5690

Browse files
authored
VAPI-1526 added uui property, description and example (#1098)
* VAPI-1526 added uui property, description and example * indentation is done * Indentation changes
1 parent 9856870 commit 0ea5690

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

site/docs/voice/webhooks/initiate.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ The Initiate event is fired when an inbound call is received for a Telephone Num
2727
| applicationId | The id of the application associated with the call. |
2828
| to | The phone number that received the call, in E.164 format (e.g. +15555555555). |
2929
| from | The provided identifier string of the caller used in the `from` field of the original call. |
30+
| uui | (optional) The value of the `User-To-User` header to send within the initial `INVITE`. Must include the `encoding` parameter as specified in [`RFC 7433`](https://tools.ietf.org/html/rfc7433). Only `base64` and `jwt` encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters. |
3031
| direction | The direction of the call; can only be `inbound`. The direction never changes. |
3132
| callId | The call id associated with the event. |
3233
| callUrl | The URL of the call associated with the event. |
@@ -91,3 +92,26 @@ Content-Type: application/json
9192
}
9293
}
9394
```
95+
96+
### Initiate Event with uui Information
97+
98+
```json
99+
POST http://yourUrl.example/initiate
100+
Content-Type: application/json
101+
102+
{
103+
"eventType" : "initiate",
104+
"eventTime" : "2019-06-20T15:56:11.554Z",
105+
"accountId" : "55555555",
106+
"applicationId" : "7fc9698a-b04a-468b-9e8f-91238c0d0086",
107+
"from" : "+15551112222",
108+
"to" : "+15553334444",
109+
"uui" : "eyJhbGciOiJIUzI1NiJ9.WyJoaSJd.-znkjYyCkgz4djmHUPSXl9YrJ6Nix_XvmlwKGFh5ERM;encoding=jwt,aGVsbG8gd29ybGQ;encoding=base64",
110+
"direction" : "inbound",
111+
"callId" : "c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d",
112+
"callUrl" : "https://voice.bandwidth.com/api/v2/accounts/55555555/calls/c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d",
113+
"startTime" : "2019-06-20T15:54:22.234Z"
114+
}
115+
```
116+
117+

0 commit comments

Comments
 (0)