From Bright Pattern Documentation
< 5.2:Trunk-and-sms-account-api-specification
Revision as of 04:32, 29 May 2024 by BpDeeplTranslateMaintenance (talk | contribs) (Updated via BpDeleteTranslateTags script)
Create SMS Account
This method creates an SMS account with name <sms_account_name>. The host and port parameters are required; the other parameters are optional.
The smppType parameter can accept one the following values:
- TRANSCEIVER
- SENDER
- RECEIVER
Request
| URL | http[s]://<host>:<port>/configapi/v2/selfservice/smsaccount/<sms_account_name> |
| Method | POST |
| Body | Tenant and trunk registration parameters (content type: application/JSON) |
| Example |
{
"carrier":"the best provider",
"host":"host name",
"port":9999,
"maxRate":33,
"systemId":"system ID",
"password":"top secret",
"smppType":"SENDER"
}
|
For more information about SMS account parameters, see the Bright Pattern Contact Center Service Provider Guide, section SMS/MMS Accounts.
Response
| Code | Description |
| 200 | Success |
| 400 | Bad arguments |
| 403 | Access denied |
| 500 | Server error |