patch https://examplebaseURL.com/v1/api/apps//recording-event-sub
Response Format
| Parameter | Type | Description |
|---|---|---|
| enabled | Boolean | The value must be true or false. It is "true" when the subscription is successful, while it is "false" when it fails. |
| url | String | The webhook URL. In access to this URL, you can receive a recording file notification in CINNOX. |
| updatedAt | String | The updated date and time of this subscription. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z. |
Notification of Recording File
You can receive the notification once the recording file is created after subscribing to this event.
| Notification Details | Type | Description |
|---|---|---|
| type | String | The value must be "message". |
| challenge | String | (Internal Use) |
| message.type | String | The type of the recording file. It is "call" if the recording file comes from a call, while it is "conference" if the recording file comes from a conference. |
| message.status | String | It is "success" if the recording the call or conference succeeds, while it is "fail" if recording those fails. |
| message.serviceId | String | The Service ID. |
| message.id | String | The value corresponds to that of the message.type. If the value of the message.type is "call", the value is a Call ID. If the value of the message.type is "conference", the value is a Conference ID. |
Webhook URL Requirement
The webhook URL needs to be verified. After that, you will get a POST request with an Action and are required to set the response in JSON Response format as shown below:
Note that the JsonResponse result is JSON encoding of the Action Endpoint Response.
Action Endpoint Request {
- Challenge string json:"challenge"
- }
Action Endpoint Response {
- Challenge string json:"challenge"
- }
Json Response {
- Code int json:"code"
- Result json.RawMessage json:"result"
- }