CPaaS Configuration
- DarkLight
CPaaS Configuration
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Communications Platform as a Service (CPaaS) configuration in SMS (Short Message Service) refers to the setup and management of a cloud-based platform that activates businesses to integrate real-time communication features such as SMS, voice, and video into their applications through APIs. This allows application to deliver messages and notifications without needing to build backend infrastructure from scratch.
CPaaS Provider: Twilio Flex, Cisco UCCX, Amazon Connect Pinpoint, and Five9 VCC
Select the CPaaS Provider and perform the configuration accordingly.
Twilio Flex
To configure a new CPaaS provider as Twilio Flex:
Select the type of authentication from Account SID or API Key.
If the selected authentication type is Account SID, enter Auth Token and SMS Receiver API URL.
If the selected authentication type is API Key: enter the following:
Enter the Account SID: The account String ID provided by Twilio Flex for this application.
Enter the API Key: The API Key provided by Twilio Flex for this user.
Enter the API Secret: The API Secret key provided by Twilio Flex. The API Key and API Secret together complete the authentication.
Enter the SMS Receiver API URL: This is the URL for the SMS Receiver API.
URL Example: https://<fqdn/hostname<or>localIPAddress>/HttpSmsReceiverApi/api
Click Next.
Note:
This configured URL is populated in the IVR Template Editor for your IVR campaigns.
Nexmo and Others
To configure a new CPaaS provider as Nexmo:
Select a service provider from the dropdown list.
Enter the SMS API URL. This is only applicable if you choose Others from the service provider dropdown list.
Enter the SMS API ID to access the SMS provider’s API.
Enter the SMS API Token required by the SMS provider to authenticate the API ID.
Example: https://<fqdn/hostname<or>localIPAddress>/HttpSmsReceiverApi/api
Enter the SMS Receiver API URL for the SMS Receiver API.
Click Next.
Amazon Connect Pinpoint
You must first configure Amazon Connect Pinpoint. Refer to the documentation on Amazon's website at Amazon Pinpoint Documentation for full details on how to configure and use this application in SMS campaigns.
Select Amazon Pinpoint as the service provider from the dropdown list.
Enable Role-based Authentication if you are hosting the application server on AWS-EC2 and this AWS-EC2 instance has access to the Pinpoint project. Turn this OFF if an AWS-IAM account can access the Pinpoint project or if the server is not hosted on AWS-EC2.
Enter the AWS App ID.
Enter the AWS Access Key and AWS Secret Key.
Note:
These are not required if you are using Role-based Authentication.
Enter the AWS Region and the AE SMS API URL of the HttpSmsReceiverApi Web API application.
Five9 VCC
To configure a new CPaaS provider as Five9 VCC:
Select Five9 VCC as the service provider from the dropdown list.
Set the value for Batch Size. This option enables you to accommodate multiple phone numbers in a single API request, allowing efficient batch processing of phone number data.
Enter the Five9 VCC API URL. This is the base URL of the Five9 VCC API servers.
Enter the Domain ID to access and manage the domain.
Enter the Client ID and Client Secret Key to obtain an access token from the Five9 VCC cloudauthsvcs endpoint. This combination is required for authentication.
Enter the SMS Receiver API URL for the SMS Receiver API.
Example: https://<fqdn/hostname<or>localIPAddress>/HttpSmsReceiverApi/api
Update or Delete CPaaS Configuration
Select the CPaaS Name and click Edit to update the configuration.
Update the appropriate parameters and click Save.
To delete, select the CPaaS Name and click Delete.
Click OK on the confirmation pop-up.
Fields
Fields | Description |
|---|---|
AWS Region | This is the AWS region that hosts the Amazon Pinpoint project. |
AE SMS API URL | This is the base URL of the HttpSmsReceiverApi Web API application. |
AWS Secret Key | This is the secret key (similar to a password) for the AWS Access Key configured. The combination of an access key ID and a secret access key is required for authentication. |
AWS Access Key | This is the key to access your AWS S3 bucket. Access Keys are used to sign the requests you send to Amazon S3. AWS validates this key and allows access. You use access keys to sign API requests that you make to AWS. |
AWS App ID | This is the AWS Pinpoint project ID with the SMS Channel enabled. |
Role-based Authentication | Turn this ON if you are hosting the application server on AWS-EC2 and this AWS-EC2 instance has access to the Pinpoint project (via an assumed role). Turn this OFF if an AWS-IAM account can access this Pinpoint project or if the server is not hosted on AWS-EC2. |
Account SID | This is a unique key used to identify specific resources. Twilio Flex SIDs have 34 digits, and you can identify the type of SID and the product association by the first two characters. |
API Key | This type of authentication is required when you use APIs of Twilio Flex to send SMS messages from your campaigns. |
Auth Token | The authorization token to authenticate the user. |
SMS Receiver API URL | This is the URL for the SMS Receiver API. |
API Secret | The API secret key provided by Twilio Flex. |
SMS API URL | This is the URL for the application to access the SMS sender API. |
SMS API ID | This is the ID required to access the SMS provider’s API. |
SMS API Token | This is the credential required by the SMS provider to authenticate the above ID. |
Five9 VCC API URL | Base URL of the Five9 VCC API servers. Following are the URLs of various regions. US alpha - https://api.alpha.us.five9.net US - https://api.prod.us.five9.net UK - https://api.prod.uk.five9.net |
Domain ID | A Domain ID to access and manage the Five9 VCC domain. |
Client ID and Client Secret Key | The Client ID and Client Secret Key are utilized to obtain an access token from the Five9 VCC cloudauthsvcs endpoint. This combination is required for authentication. |
Batch Size | A single API request can accommodate multiple phone numbers. This allows for efficient batch processing of phone number data. |
Was this article helpful?