This method returns all system keywords for a given number.
Endpoint
GET:https://messaging.esendex.us/Messaging.svc/GetSystemKeywordResponses?LicenseKey={LICENSEKEY}&Number={NUMBER}
Syntax
AssignKeyword(LicenseKey, Number)
Request Parameters
Parameter Name | Description | Data Type | Required | Sample Value |
---|---|---|---|---|
LicenseKey | Your license key. | GUID | True | 00000000-0000-0000-0000-000000000000 |
Number | One of your numbers. | String | True | 7575550000 |
Response
Returns: SystemKeywordResponses
object
Code Samples
You can use any programming language you want with our API, as long as it can make a REST or SOAP call. Here are examples for some of the most common platforms.
C#
// https://messaging.esendex.us/Messaging.svc?wsdl was added as a Service Reference and given the name WSDL
using WSDL;
var client = new MessagingClient(MessagingClient.EndpointConfiguration.mms2wsHttpBindingSecure);
var responses = await client.GetSystemKeywordResponsesAsync(YOUR_LICENSE_KEY, YOUR_NUMBER);
Console.WriteLine("HELP: " + responses.Help);
Console.WriteLine("RESUME: " + responses.Resume);
Console.WriteLine("STOP: " + responses.Stop);
JavaScript
const params = new URLSearchParams({
'LicenseKey': '00000000-0000-0000-0000-000000000000',
'Number': '7575550000'
});
const url = 'https://messaging.esendex.us/Messaging.svc/GetSystemKeywordResponses?' + params.toString();
const response = await fetch(url, {
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
}
});
const responses = await response.json();
console.log(responses);
JSON Response
{
"Help": "String content",
"Resume": "String content",
"Stop": "String content"
}
Python
import httpx
headers = {"Accept": "application/json"}
url = "https://messaging.esendex.us/Messaging.svc/GetSystemKeywordResponses"
request = {
"LicenseKey": "00000000-0000-0000-0000-000000000000",
"Number": "7575550000",
}
with httpx.Client(headers=headers) as client:
response = client.get(url=url, params=request)
response.raise_for_status()
print(response.json())
Ruby
require 'json'
require 'net/http'
headers = { Accept: 'application/json', 'Content-Type': 'application/json' }
uri = URI('https://messaging.esendex.us/Messaging.svc/GetSystemKeywordResponses')
params = {
'LicenseKey': '00000000-0000-0000-0000-000000000000',
'Number': '7575550000'
}
uri.query = URI.encode_www_form(params)
response = Net::HTTP.get(uri, headers)
raise response.message if response.is_a?(Net::HTTPClientError) || response.is_a?(Net::HTTPServerError)
puts JSON.parse(response)
XML Response
<SystemKeywordResponses xmlns="http://sms2.cdyne.com">
<Help>String content</Help>
<Resume>String content</Resume>
<Stop>String content</Stop>
</SystemKeywordResponses>