SetPostbackEnabledForLicenseKey
This method retrieves postback settings for a given license key.
Endpoint
GET:https://messaging.esendex.us/Messaging.svc/SetPostbackEnabledForLicenseKey?LicenseKey={LICENSEKEY}&PostbackType={POSTBACKTYPE}&Enabled={ENABLED}
Syntax
SetPostbackEnabledForLicenseKey(LicenseKey)
Request Parameters
Parameter Name | Description | Data Type | Required | Sample Value | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
LicenseKey |
Your license key. |
GUID
|
True | 00000000-0000-0000-0000-000000000000 | ||||||||||
PostbackType |
Indicates whether the postback URL is used for incoming messages, outgoing messages, or delivery receipts.
|
Enum
|
True | 0 - All | ||||||||||
Enabled |
Indicates whether the postback URL is enabled on the number. |
Boolean
|
True | True |
Response
Returns: SetPostbackEnabledForLicenseKeyResponse
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.
// 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 postbackType = SMSPostbackType.All;
var enabled = true;
var response = await client.SetPostbackEnabledForLicenseKeyAsync(
YOUR_LICENSE_KEY, postbackType, enabled);
Console.WriteLine(response);
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Properties;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;
public final class GetPostbackSettingsForLicenseKey {
public static void main(String[] args) {
try {
URL url = new URL("https://messaging.esendex.us/Messaging.svc/GetPostbackSettingsForLicenseKey?"
+ "LicenseKey=00000000-0000-0000-0000-000000000000");
try {
InputStream in = url.openStream();
StreamSource source = new StreamSource(in);
printResult(source);
} catch (java.io.IOException e) {
}
} catch (MalformedURLException e) {
}
}
private static void printResult(Source source) {
try {
ByteArrayOutputStream bos = new ByteArrayOutputStream();
StreamResult sr = new StreamResult(bos);
Transformer trans = TransformerFactory.newInstance().newTransformer();
Properties oprops = new Properties();
oprops.put(OutputKeys.OMIT_XML_DECLARATION, "yes");
trans.setOutputProperties(oprops);
trans.transform(source, sr);
System.out.println("**** Response ******");
System.out.println(bos.toString());
bos.close();
System.out.println();
} catch (Exception e) {
}
}
}
<?php
$url = 'https://messaging.esendex.us/Messaging.svc/GetPostbackSettingsForLicenseKey?LicenseKey=00000000-0000-0000-0000-000000000000';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPGET, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'Accept: application/json'));
$response = curl_exec($ch);
curl_close($ch);
print_r($response);
?>
import httpx
headers = {"Accept": "application/json"}
url = "https://messaging.esendex.us/Messaging.svc/SetPostbackEnabledForLicenseKey"
request = {
"LicenseKey": "00000000-0000-0000-0000-000000000000",
"PostbackType": 0,
"Enabled": True,
}
with httpx.Client(headers=headers) as client:
response = client.get(url=url, params=request)
response.raise_for_status()
print(response.json())
require 'json'
require 'net/http'
headers = { Accept: 'application/json', 'Content-Type': 'application/json' }
uri = URI('https://messaging.esendex.us/Messaging.svc/SetPostbackEnabledForLicenseKey')
params = {
'LicenseKey': '00000000-0000-0000-0000-000000000000',
'PostbackType': 0,
'Enabled': true
}
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)
0
<SMSPostbackReturnCode xmlns="http://sms2.cdyne.com">NoError</SMSPostbackReturnCode>