Loading...

Gateway Campaign


A Gateway Campaign allows to send an outgoing SMS message by performing an HTTP/1.1 POST to the action-pushcampaign endpoint:

POST   https://api.3seventy.com/api/v2.1/account/{AccountId}/action-pushcampaign

POST Body

{
"Channels": [22],
"Targets": ["+15125773033"],
"Message": "Acme: Hello World! Text STOP to End",
"Execute" : "true"
}

Let's take a look at the information you need to provide to the endpoint.

Parameter Type Description
Channels Array TrueDialog supports different communication / transport channels: SMS, MMS, Voice, Email. You need to specify id of the channel you want to use. Your account is already provisioned with a SMS channel and you received the ID in the confirmation email.
Targets Array A list of destination phone numbers. E.164 format
Message String The text of the message you want to send.
Execute Boolean Instructs Platform to Execute the action.

Send a Gateway Campaign with curl

curl -v --user {apiKey}:{Secret} "https://api.3seventy.com/api/v2.1/account/{AccountId}/action-pushcampaign" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"Channels": [22],"Targets": ["+15125773033"],"Message": "Acme: Hello World! Text STOP to End",  "Execute ": "true "}'

If your REST request was successful you received an HTTP 201 status and the SMS is being processed by the TrueDialog platform and should be delivered within seconds.