POST http://webapi.mymarketing.co.il/api/external/operational/sms_message
Create and send a new operational sms message
Request Information
URI Parameters
Body Parameters
Name
Description
Type
Additional information
Request Formats
application/json, text/json
Sample:
{ "details": { "unsubscribe_text": "sample string 1", "can_unsubscribe": true, "name": "sample string 3", "from_name": "sample string 4", "sms_sending_profile_id": 5, "content": "sample string 6" }, "scheduling": { "send_now": true, "scheduled_date_utc": "2016-12-24T14:12:12" }, "customers": [ { "externalId": "sample string 1", "externalName": "sample string 2" }, { "externalId": "sample string 1", "externalName": "sample string 2" } ] }
application/xml, text/xml
Sample:
<ApiExternalSmsCampaignPostContainer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.SmsCampaignReport"> <customers> <ApiExternalSMS> <externalId xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">sample string 1</externalId> <externalName xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">sample string 2</externalName> </ApiExternalSMS> <ApiExternalSMS> <externalId xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">sample string 1</externalId> <externalName xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">sample string 2</externalName> </ApiExternalSMS> </customers> <details> <content>sample string 6</content> <from_name>sample string 4</from_name> <name>sample string 3</name> <sms_sending_profile_id>5</sms_sending_profile_id> <can_unsubscribe>true</can_unsubscribe> <unsubscribe_text>sample string 1</unsubscribe_text> </details> <from_name>sample string 1</from_name> <scheduling> <scheduled_date_utc>2016-12-24T14:12:12</scheduled_date_utc> <send_now>true</send_now> </scheduling> </ApiExternalSmsCampaignPostContainer>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Name
Description
Type
Additional information
id
SMS campaign id
integer
name
Operational campaign name. Internal use only.
string
Required
from_name
From name. Required if "sms_sending_profile_id" is not used. The sender name. The name must be up to 11 English letters without special characters or spaces.
string
sms_sending_profile_id
SMS sending profile ID. Required if "from_name" is not used. Can be found using the endpoint "Get account's sms campaigns.." or in the UI (go to Mobile -> SMS -> SMS list -> inspect/F12)
integer
content
SMS content.
string
Required
Response Formats
application/json, text/json
Sample:
{ "id": 1, "name": "sample string 2", "from_name": "sample string 3", "sms_sending_profile_id": 4, "content": "sample string 5" }
application/xml, text/xml
Sample:
<ApiSmsCampaignInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.SmsCampaignReport"> <content>sample string 5</content> <from_name>sample string 3</from_name> <name>sample string 2</name> <sms_sending_profile_id>4</sms_sending_profile_id> </ApiSmsCampaignInfo>