List Instance Codes

Overview

List all short/long codes for a given instance.

URL

Http access method: GET

Parameters on the following URL are inside braces { }

{base_url}/rest/api/shortcodes/{instanceId}/{userName}/{publicKey}/{signature}

Parameter Name	Description
instanceId	An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
userName	The user name associated with the instance. This parameter must be Base64 encoded
publicKey	The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature	The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getShortcodes</input>
<status>OK</status>
<description>Completed</description>
<result>
	<shortcodes>
		<shortcode>
			<sc>0000000</sc>
		</shortcode>
 
		...
 
		<shortcode>
			<sc>1111111</sc>
		</shortcode>
        </shortcodes>
</result>

Result parameters

Parameter Name	Description	Possible Values
shortcode.sc	The short/long code	String