CapabilitiesWhy CINNOXSolutionPricingPartnersBlog
中文Start for FREE

Create/Edit/Delete Call Event Subscription

patch https://examplebaseURL.com/v1/api/apps//call-event-sub

 

Response Format

ParameterTypeDescription
enabledBooleanThe value must be true or false. It is "true" when the subscription is successful, while it is "false" when the subscription fails.
urlStringThe webhook URL. In access to this URL, you can receive the notification of a call when it starts or ends in CINNOX.
updatedAtStringThe updated date and time of this subscription. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z.

 

Notification of Call

You can receive a call notification by accessing the webhook URL after subscribing to the call event.

  • When a call starts, you will receive the following notification details:
Notification DetailsTypeDescription
message.idStringThe ID of the call.
message.statusStringIt must be "CallStart" when a call starts.
message.serviceIdStringThe service ID in CINNOX.
message.caller.eidStringThe staff's EID of the caller.
message.caller.numberNumberThe caller's phone number.
message.callees.eidStringThe staff's EID of the callee.
message.callees.numberNumberThe callee's (aka called party/receiver) phone number.

 

  • When a call ends, you will receive the following notification details:
Notification DetailsTypeDescription
message.statusStringIt must be "CallEnd" when a call ends.
message.serviceIdStringThe service ID in CINNOX.
message.idStringThe ID of the call.

 

🚧

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"
+ }

 

Language