Method: SendSMSmsg (And MMS!)

Method Type: Post

This method will be called by your application to send a text or picture message to an opted-in Customer from the store you assign within your auth string. It is used to send text messages in all instances except when a mobile subscriber initiates a keyword to a CRM Text short code. In the instance of handset initiated keywords, the CRM Text SMS API automates the message that is returned to the mobile subscriber. More on what we automate is here.

The CRM Text SMS API supports up to 1600 characters within a text message. However, there are still several carriers that will not deliver a 1600 character message as one. AT&T, Verizon, and T-Mobile will. Sprint will not. And this can change at any time. You should also be aware of using special characters. More on that here.

For MMS messages, you will be required to host the file type that you wish to send. The CRM Text SMS API only supports .Png .Jpg and .Gif files at a size of 4.5 MB or lower. Images are resized automatically by the CRM Text SMS API upon transmission. Video messaging is not available at this time. The CRM Text SMS API does not check the file type of the picture you wish to send. Please test and re-test. You are responsible if you send an unsupported file type as a picture message.

By default, all calls to this method will go out on the communication short code that the customer is assigned to by CRM Text for the requested store. If the customer is not opted-in, they will not receive the message.

Additionally, you can use this method to send campaigns to segmented data within your entire opt-in database. If you send us one message per second we will deliver one message per second. But you can send a maximum of 30 requests per second and we will then deliver messages at our bandwidth capacity. Keep in mind our codes are shared. So your bandwidth could be as low as 3mps and as high as 30mps depending on other Client campaigns. The requests are queued on our side. We can support up to 90mps. However, this carriers additional costs. Please contact Support if that is a requirement.

  Restrictions


  • The mobile subscriber must be an opted-in customer of the store before you may use this method.
  • Messages are limited to 1600 characters. But please read this so you know why you should stick to 160 characters per text message.
  • MMS file types must be .Jpg .Gif and .Png and URL hosted. HTTP and HTTPS URL's are supported.
  • Pictures over 4.5 MB will not be delivered.

  Suggestions


  • Keep your messages short, sweet and simple and you'll be rewarded with higher conversion and delivery rates.
  • MMS is not yet perfected by the carriers. You will experience a higher failure rate. You are not billed for failed messages.
  • You may send an MMS only if required. Leave the message parameter blank and make sure you have an MMS URL.
  • If you want to send a lot of messages to targeted mobile numbers, spin up your code to deliver 30 method requests per second.
  • If you are interested in sending one time alerts for download links or other use cases regardless of opt-in status, please contact Support.

Request Examples

Sending an SMS:
https://restapi.crmtext.com/smapi/rest?method=sendsmsmsg&phone_number=&message=
Sending an MMS:
https://restapi.crmtext.com/smapi/rest?method=sendsmsmsg&phone_number=&message=&mmsurl=


Request Parameters

Name Required Value Description
phone_number Yes Integer 10 digit mobile phone number (Example: 9993336666)
message *No String Message content of less than 1600 characters (We advise under 160 characters!). Required when no MMS URL is present.
mmsurl No String The URL of the hosted image in either .Jpg .Png or .Gif formats that is less than 450kb in size.

XML Sample Successful Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<response op= "sendsmsmsg" status= "200" message= "ok">
<message>
<msgID>999111222</msgID>
<message>John, your vehicle is due for service. Can I schedule an appt for you?</message>
<timestamp>2014-08-11 14:23:36</timestamp>
<txnid>0987654321</txnid>
<msg_direction>MT</msg_direction>
<user_id>1234</user_id>
<customer>
<custId>1234567891011</custId>
<subacct>456</subacct>
<timestamp>2014-08-11 09:19:12</timestamp>
<optinStatus>3</optinStatus>
<custName>John Queue</custName>
<custMobile>9993338888</custMobile>
</customer>
</message>
</response>

XML Sample Error Response

1
2
<response op= "sendsmsmsg" status= "4xx" message= "reason for Error">
</response>