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.
The search can be used with various criteria passed via query parameters (all criteria combinations have AND semantic).
Note.To avoid validation errors and inconsistent results query parameters need to be encoded (see RFC 3986, section 2.1).
Example. Find subscriptions having applications 'app1' and 'app2', and the resource '100200300400'.

/subscriptions/1/subscription/SMS?applicationId=app1&applicationId=app2&resource=100200300400

Please log in to see full path URL. Learn why.

get

/subscriptions/1/subscription/{channel}

Authorizations:

Scopes:

subscriptions:manage

path Parameters

channel

required

string

Enum: "BLOCKLIST" "CUSTOMER_ENGAGEMENT" "EMAIL" "FACEBOOK" "KAKAO_ALIM" "KAKAO_CHINGU" "LINE" "MMS" "MOBILE_IDENTITY" "MOBILE_PUSH" "NUMBER_LOOKUP" "OPEN_CHANNEL" "RCS" "REGISTRATION" "SMS" "VIBER" "VOICE_VIDEO" "WHATSAPP" "ZALO"

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

query Parameters

page	integer <int32> >= 0 Default: 0 Results page to retrieve (0..N).
size	integer <int32> [ 1 .. 100 ] Default: 20 Number of records per page.
applicationId	string [ 1 .. 255 ] characters CPaaS-X application identifier.
entityId	string [ 1 .. 255 ] characters CPaaS-X entity identifier.
callsConfigurationId	string [ 1 .. 128 ] characters Calls configuration identifier.
resource	string [ 1 .. 255 ] characters Resource.
user	string [ 1 .. 255 ] characters User.

Responses

200

Success.

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not found.

429

Too many requests.

500

Internal Server Error

Request samples

Example

cURL

Copy

curl -L -g 'https://{baseUrl}/subscriptions/1/subscription/{channel}' \
-H 'Authorization: {authorization}' \
-H 'Accept: application/json'

Response samples

Content type

application/json

Copy

Collapse all


{"results": 
[
{"subscriptionId": "string",
"name": "string",
"profile": 
{"profileId": "string",
"security": 
{"authId": "string"
}
},
"events": 
["string"
],
"criteria": 
[
{"applicationId": "string",
"entityId": "string",
"callsConfigurationId": "string"
}
],
"resources": 
["string"
],
"users": 
["string"
]
}
],
"paging": 
{"page": 0,
"size": 0,
"totalPages": 0,
"totalResults": 0
}
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products

Learn more

Service status

Privacy documents Terms of use