API - v1.0 - send-message
Description
- Sends a message to a group or a set of addresses.
- Optionally opens a specified Recipient Callback URL to communicate delivery status changes and replies for each recipient.
- Returns nothing if the message is queued successfully.
HTTP Binding
| URL: | http://api.sendgm.com/v1.0/method/send-message |
| Method: | POST |
Parameters
| Name | Description | Required |
|---|---|---|
| ApiKey | Valid API Key. | Yes |
| Message.MessageRef | Your unique identifier for this message. | No |
| Message.RecipientContactGroupNamesCsv | Comma delimited list of group names. | Only if Message.RecipientAddressesCsv is omitted |
| Message.RecipientAddressesCsv | Comma delimited list of addresses. | Only if Message.RecipientContactGroupNamesCsv is omitted |
| Message.SenderAddressName | Name of sender. | No |
| Message.SenderAddressPhone | Name of sender. | Only if message has phone recipients |
| Message.SenderAddressEmail | Name of sender. | Only if message has email or SMS recipients |
| Message.Subject | Subject of message. | Yes |
| Message.Body | Generic body. | Only if Message.EmailBody, Message.Phonebody, and Message.SmsBody are all omitted |
| Message.EmailBody | Body of message for email recipients. | No |
| Message.PhoneBody | Body of message for phone recipients. | No |
| Message.SmsBody | Body of message for SMS recipients. | No |
| Message.ReplyCodesCsv | Comma delimited list of reply codes. | No |
| Message.RecipientCallbackUrl | URL that should be opened to update the delivery status and replies from each recipient. | No |
Example Message to Group
Your code should emulate the posting of this form to send a message to one or more groups...
Example Message to Addresses
Your code should emulate the posting of this form to send a message to one or more contacts...