MEP APIs

Get Subscriptions for an End User

This operation enables you to retrieve a detailed list of an end user’s active subscriptions.

Subscriptions that the end user has been removed from are not included in the list.

Quick facts

Method	GET
Returns	Accepted response: XML Rejected response: plain text
Available	All regions
Prerequisites	You must have MEP provisioned with OpenMarket, and the following roles set in the user account: Main Roles: Subscription Manager/User Other Roles: View and download user details, HTTP Subscription API user
More information	See MEP Operations and Making Subscription Requests.

Try It Out

If you'd like to try out this call using cURL, see Making Subscription Requests, which will take you through tasks such as creating and disabling subscriptions, and adding or removing end users.

Making a Request

Definition

GET https://cmx2api.openmarket.com/subscriptionapi/viewusersubscriptions

URL example

>https://cmx2api.openmarket.com/subscriptionapi/viewusersubscriptions?username=MyUsername&password=P4S5W0Rd&msisdn=12515550130&all=true

Query parameters

Parameters must be URL encoded.

Parameter	Description
username	The username used to access MEP. Required: yes Type: string
password	The password associated with the MEP username. Required: yes Type: string
msisdn	Mobile number of the end user that you are retrieving subscription details for. This must be in international format but without a leading + symbol. For example: 12515550145 (US) or 447700900765 (UK). Required: yes Type: integer
all	Whether the response includes subscriptions that are disabled in MEP, but that the end user is subscribed to. Either: true — The response includes both enabled and disabled subscriptions. false — The response only includes the enabled subscriptions. Required: no Type: Boolean Default: false

Header fields

There is no data required in the header.

Response from OpenMarket

Accepted requests

OpenMarket responds to a successful request with a status code of 200 and the details of available subscription collections in the response body.

HTTP/1.1 200 OK
Date: Tue, 15 Mar 2016 17:46:55 GMT
Server: Apache-Coyote/1.1
Transfer-Encoding: chunked
Content-Type: text/plain
					
<?xml version="1.0" encoding="ISO-8859-1"?>
<subscriptions>
   <subscription>
      <id>F9E8D7C6B5</id>
      <name>My New Subscription</name>
      <description/>
      <collection>A1B2C3D4E5F6</collection>
      <enabled>true</enabled>
   </subscription>
   <subscription>
      <id>D7C6B5F9E8</id>
      <name>test</name>
      <description/>
      <collection>A1B2C3D4E5F6</collection>
      <enabled>true</enabled>
   </subscription>
</subscriptions>

Response body

The XML response body will include following data.

Element	Description
subscriptions	Root element. Contains one or more of the element: subscription. Returned: Always
subscription	Element containing information about a specific subscription. Returned: Always
id	A unique alphanumeric ID that OpenMarket has given the subscription. These are referred to as listIds in broadcast operations. Type: string Returned: Always
name	The name of the subscription. Type: string Returned: Always
description	The description of the subscription. Type: string Returned: Always
collection	The ID of the collection that the subscription belongs to. Type: string Returned: Always
enabled	Whether the subscription is enabled or disabled. For information about disabled subscriptions, see Creating, Disabling, and Re-enabling Subscriptions. Type: Boolean Returned: Always

Rejected requests

If your request is rejected then the body of the response will contain a plain text description of the error. For example:

HTTP/1.1 401 Unauthorized
Date: Tue, 15 Mar 2016 11:48:56 GMT
Server: Apache-Coyote/1.1
Connection: close
Transfer-Encoding: chunked
Content-Type: text/plain
			
Your username and/or password is incorrect. Check and try again.

See Response error messages below for a list of the possible error messages.

Testing your integration

As subscription operations do not send messages, the best way to test your integration is directly with MEP. We recommend that you test regularly as you build your campaigns and services in MEP, so that you can troubleshoot any issues faster.

For more information on using each operation, see Making Subscription Requests.

Troubleshooting

Response error messages

These error messages are returned in the response body when there was a problem with receiving the request.

Message	Description
Your request is invalid, specifically the following parameter is incorrect: <parameter>=<value>	You request contains a problem with the specified mandatory parameter that has stopped MEP from being able to process the request. If the <value> is “null”, then the parameter name is misspelled or the parameter is missing. Otherwise, the value you specified is invalid or does not match the available options. Correct the error and resend the message.
Your username and/or password is incorrect. Check and try again.	Either the username or the password parameter has not been correctly specified. Both parameters are mandatory. Check that both parameters are specified, and that you have entered the correct values for each parameter.
You do not have the necessary roles or permissions to perform the action: <description>	Your access rights in MEP do not allow you use the operation. The information in the <description> part of the response will tell you the role or permission that you are missing.