Before You Begin
MEP Operations
You can integrate with MEP APIs to perform a variety of MEP tasks programmatically.
Available APIs
API |
Description |
Supported operations |
---|---|---|
Invoke Service |
Enables you to trigger an existing MEP service for a specified end user. In the request you can include variables related to the end user or the service, letting you both add and update variables as required. The Invoke Service API supports the same basic functionality as the Inject Message API. The primary differences between the two are that Invoke Service provides enhanced security and high availability capabilities. |
|
Inject message |
Enables you to send messages into MEP as if they were sent from an end user. This enables you to use an external platform, such as a web service, to trigger a MEP service for an end user. You can also set variables related to the end user or service in the same request. |
|
Broadcasting |
Enables you to create SMS, MMS, and service broadcasts to end users in one (or more) of your MEP subscriptions. You can also specify when you want a broadcast to initiate, the message originator, the character encoding to use, and whether to allow multipart messages. |
|
Subscriptions |
Enables you to manage subscriptions. You can:
|
|
Variables |
Use to create and delete variables in MEP as well as retrieve and set variable values. This enables you to create and adjust values in services and service collections. This API is restricted to use with variables that use the service and servicecoll scopes. For detailed information about variables and variable scopes, see Variables. |
|
Specifying the network parameter
Some operations, such as Add End User to a Subscription, include a network parameter.
The network parameter identifies the mobile operator for the mobile number. You may need to pass the parameter to MEP the first time an end user uses your service.
The MEP site hosts a list of mobile operator codes. You will need to log in before you can see the codes.
The next table shows when this is needed.
Message type |
US and Canada |
UK and rest of world |
---|---|---|
Standard rate SMS US |
Required |
N/A |
Standard rate SMS US (One account) |
Not required |
N/A |
Premium rate SMS |
Not applicable, as US and Canada premium SMS not supported |
Required |
Message flows that are mobile operator specific |
Required |
Required |
UK and rest of world messaging (non-premium) |
N/A |
Not required |
If MEP already knows an end user’s mobile operator details, then you do not need to include the network parameter in future requests (for example, if MEP has received an SMS from the user to your short code, or has performed a mobile operator lookup on their mobile number). This means that subsequent requests for the same end user do not need to include the network parameter.
When not specified, the network parameter defaults to UNKNOWN. This does not overwrite any network value that MEP already has associated with that user.