List the current mobile operators table. This may vary depending on client's specify connectivity requirements.
Parameters on the following URL are inside braces { }
{base_url}/rest/api/getCarriers/{instanceId}/{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 |
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 |
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>getCarriers</input> <status>OK</status> <description>Completed</description> <result> <carriers> <carrier> <id>1</id> <name>Movilnet</name> <description>Movilnet</description> </carrier> <carrier> <id>2</id> <name>Telcel</name> <description>Movistar</description> </carrier> <carrier> <id>3</id> <name>Digitel</name> <description>Digitel</description> </carrier> </carriers> </result>
Parameter Name | Description | Possible Values |
---|---|---|
carrier.id | The mobile operator (carrier) ID | Number |
carrier.name | The mobile operator name | Text |
carrier.description | The mobile operator description | Text |
List all currently active campaigns. Useful to clients handling massive amount of campaigns with a fast lifecycle.
Parameters on the following URL are inside braces { }
{base_url}/rest/api/getActiveMims/{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 who owns the campaign |
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 |
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>getActiveMims</input> <status>OK</status> <description>Completed</description> <result> <mIMs> <mim> <id>1</id> <msgtype>1</msgtype> <name>MIM1</name> <description>*</description> <functionTag>DEFAULT</functionTag> <active>1</active> </mim> ... <mim> <id>2</id> <msgtype>2</msgtype> <name>MIM2</name> <description>*</description> <functionTag>DEFAULT</functionTag> <active>1</active> </mim> </mIMs> </result>
Please be aware that the <mim> tag and its content is a generic object and may apply to other responses in other methods.
Parameter Name | Description | Possible Values |
---|---|---|
mim.id | The campaign identifier number | Number |
mim.msgtype | The campaign type | Number |
mim.name | Name of the campaign | Text |
mim.description | Description used at the creation time | Text |
mim.functionTag | Function tag | Text |
mim.active | current status | 1 for active and 0 for inactive |