Send a MO message

Overview

This API allows an external system to send a virtual mobile-originated (MO) message to an SMS Program. You can send a virtual mobile-originated (MO) message for Text-for-Response or Text-To-Join program. A Text-for-Response or Text-To-Join program ID is required. This API works for both opt-in and double opt-in for both these programs.

📘

Note:

This API does not work with mGage. You can use this API only if you use SMPP to send messages.

Requirements to use this API

  • Your Campaign org must have SMS enabled by provisioning and be provisioned to send SMS messages through the Sender feature.
  • A database in your Campaign org must have SMS enabled.
  • The user making the API call must be enabled for SMS.
  • The user making the API call must have valid Oauth credentials.

📘

Note:

Up to 10 concurrent requests are allowed to our API servers at any given time when using the OAuth method for authentication.

Endpoint

post /channels/sms/programs/{programId}/virtualmo

Parameters

Attribute

Data type

Description

programId (required)

String

Text-for-Response program ID

phoneNumber (required)

String

SMS phone number.

Response codes

Scenario

Response code

Message

Success

200

User is not on an SMS-enabled Org

403

Forbidden

User calling the API is not SMS enabled

403

Forbidden

Program ID not found

404

Unable to locate SMS program ID {}

Sender feature is not enabled for this Org

405

Unsupported operation

Test your API call

Use Swagger to test your API call. To access the Swagger environment for your Org, replace {POD#} with the Pod where your Org exists:

https://api-campaign-us-[POD#].goacoustic.com/restdoc/#!/channels/programs_post_post_9

For example, here’s the link to use if your Org is on Pod 1:

https://api-campaign-us-1.goacoustic.com/restdoc/#!/channels/programs_post_post_9