Calls API and CPaaSX

The Calls API platform supports Infobip CPaaSX. In particular, the following CPaaSX features are available when using Calls API:

• Subscriptions
• Application
• Entity

Although the usage of event subscriptions is mandatory, when using Calls API, the usage of Applications and Entities is optional.

ApplicationId and EntityId on Outbound calls

Setting CPaaSX applicationId and/or entityId on an outbound call can be achieved using the following methods, setting applicationId and/or entityId values in the platform object:

• Create a call
• Create a bulk of calls

Similarly, when bridging an existing call already tagged with an applicationId and/or entityId with a new call, the applicationId and/or entityId from the parent call will be replicated on the new outbound call. These related methods are:

• Connect with new call
• Create dialog

ApplicationId and EntityId on Inbound calls

Inbound calls flagged with the applicationId and/or entityId that are specified on the number's voice setup, either when this setup is defined by API or via the Inbound configuration in the Numbers application on the web interface.

Outcome of defining CPaaSX applications and entities on Calls

When a CPaaSX applicationId and/or entityId are defined for inbound or outbound calls, these applicationId and entityId will be reflected in:

• Any Calls API event related to that call.
• Detailed voice reports generated and downloaded from the web interface.
• Calls, Conference, and Dialog Historical CDRs.
• Calls, Conference, and Dialog Recording CDRs.

Additionally, applicationId and entityId can be used a additional filter criteria for your event subscriptions. For example, if you define the following:

• a callsConfigurationId "voice-prod-app"
• two applicationId "app1" and "app2"

You could then have:

• One event subscription with solely the callsConfigurationId "voice-prod-app" as criterion.
• One event subscription with callsConfigurationId "voice-prod-app" and applicationId "app1" as criteria.
• One event subscription with callsConfigurationId "voice-prod-app" and applicationId "app2" as criteria.

The subscription used for calls related to your callsConfigurationId "voice-prod-app" depend on whether applicationId is also defined on your call and, if so, its value.