API Posting Information

API posting information for 3rd party programs

MRT avatar
Written by MRT
Updated over a week ago

Send SMS

Fields:

toRequiredRecipients Phone Number who you want to send the SMS to

fromRequiredLocal phone number you want to send the SMS from

messageRequiredMessage Content

Example Usage using CURL

curl -XPOST 'https://roor.gynetix.com/standard/api/post/manualTXT/key/[APIKEY]/response/json' --data-urlencode 'to=+1{REMOTE_PHONE_NUMBER}' --data-urlencode 'from=+1{LOCAL_PHONE_NUMBER}' --data-urlencode 'message={MESSAGE_CONTENT}'

Response:

Success : {“status”:”success”, “message”:”Message has…..”}

Failed: {“status”:”failed”, “message”:”Some reason why…..”}

Note: if you are going to be sending as a query string make sure to add the path separator on the end of the URL

Example

Add Number to Suppression

Fields:

phoneRequiredRecipients Phone Number who you want to suppress

Example Usage using CURL

curl -XPOST 'https://roor.gynetix.com/standard/api/v1/addSuppression/key/[APIKEY]/response/json' --data-urlencode 'phone=1{REMOTE_PHONE_NUMBER}'

Response:

Success : {“status”:”success”, “message”:”Phone Number added to suppression”}

Failed: {“status”:”failed”, “message”:”Some reason why…..”}

Note: if you are going to be sending as a query string make sure to add the path separator on the end of the URL

Example

Get Conversation

 

Fields:

phoneRequiredRecipients Phone Number who you want to get the conversation for

detailedOptionalSend detailed with a value of Y to get owner details with the conversation list

Example Usage using CURL

Response:

Success:

{

"messages":[

{

"dir":"OUT",

"ts":1516816290,

"date":"1\/24\/2018 10:51 AM",

"message":"Hello"

},

{

"dir":"IN",

"ts":1516822439,

"date":"1\/24\/2018 12:33 PM",

"message":"Who is this"

}

],

"suppressed":"N",

"surl":"https:\/\/roor.gynetix.com\/standard\/api\/post\/addSuppression\/key\/81b...fdff \/response\/json",

"did":"15556667777",

"type":"all"

}

Failed or No Conversation:

{"messages":[],"suppressed":"N","surl":"https:\/\/roor.gynetix.com\/standard\/api\/post\/addSuppression\/key\/81b...fdff\/response\/json","type":"all"}

Note: if you are going to be sending as a query string make sure to add the path separator on the end of the URL

Example

Did this answer your question?