POST | /api/sendmessage | ||
---|---|---|---|
POST | /api/sendmessage/immediate | ||
POST | /api/send | ||
POST | /api/sms/send | ||
POST | /api/send/immediate | ||
POST | /api/sms/send/immediate |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SMSModel | body | SMSModel | No | |
CreateCommunicationReferencesImmediately | body | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
From | form | SMSContact | No | |
To | form | List<SMSContact> | No | |
MessageBody | form | string | No | |
ReplyIsAllowed | form | bool | No | |
ReplyIsRequired | form | bool | No | |
Notes | form | string | No | |
LinkedObjectId | form | Guid | No | |
SuiteId | form | Guid | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LicenseeId | form | Guid | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
PhoneNumber | form | string | No | |
ContactId | form | Guid | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CommId | form | Guid | No | |
Reference | form | string | No | |
Status | form | bool | No | |
Message | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/sendmessage HTTP/1.1
Host: production-eros-gateway-api-sms-wa.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
SMSModel:
{
From:
{
Name: String,
PhoneNumber: String,
ContactId: 00000000000000000000000000000000
},
To:
[
{
Name: String,
PhoneNumber: String,
ContactId: 00000000000000000000000000000000
}
],
MessageBody: String,
ReplyIsAllowed: False,
ReplyIsRequired: False,
Notes: String,
LinkedObjectId: 00000000000000000000000000000000,
SuiteId: 00000000000000000000000000000000,
LicenseeId: 00000000000000000000000000000000
},
CreateCommunicationReferencesImmediately: False
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { CommId: 00000000000000000000000000000000, Reference: String, Status: False, Message: String }