platform
subscriptions-api
subscription

Get subscriptions

Returns a list of all subscriptions for the specified channel with pagination. By default, the result is sorted by creation date in descending order.<br>The search can be used with various criteria passed via query parameters (all criteria combinations have <strong>AND</strong> semantic).<br><strong>Note.</strong>To avoid validation errors and inconsistent results query parameters need to be encoded (see <strong>RFC 3986, section 2.1</strong>).<br><strong>Example</strong>. Find subscriptions having applications 'app1' and 'app2', and the resource '100200300400'.<pre>/subscriptions/1/subscription/SMS?applicationId=app1&applicationId=app2&resource=100200300400</pre>

get/subscriptions/1/subscription/{channel}

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Path parameters

channel'AGENT_OS' | 'APPLE_MESSAGES_FOR_BUSINESS' | 'BLOCKLIST' | 'CUSTOMER_ENGAGEMENT' | 'EMAIL' | 'FACEBOOK' | 'KAKAO_ALIM' | 'KAKAO_BRAND_MESSAGE' | 'LINE' | 'MMS' | 'MOBILE_IDENTITY' | 'MOBILE_PUSH' | 'NUMBER_LOOKUP' | 'OPEN_CHANNEL' | 'RCS' | 'REGISTRATION' | 'SMS' | 'VIBER' | 'VOICE_VIDEO' | 'WEB_PUSH' | 'WHATSAPP' | 'ZALO' required

Channel name. A separate subscription is needed for each channel.

Query parameters

pageinteger

Results page to retrieve (0..N).

sizeinteger

Number of records per page.

applicationIdstring

CPaaS-X application identifier.

entityIdstring

CPaaS-X entity identifier.

callsConfigurationIdstring

Calls configuration identifier.

resourcestring

Resource.

userstring

User.

Response

Success.

Changes

No recorded changes to this operation across all 1 revision of this API.