Get resource association
Get an exact resource association.
Authorizations:
Scopes:
Request rate limit:
query Parameters
| resourceType required | string Enum: "NUMBER" "DOMAIN" "ALPHA" The type of resource to be used. |
| channel required | string Enum: "SMS" "MMS" "EMAIL" The channel for which the resource will be used. |
| applicationId required | string <= 255 characters Example: applicationId=test-application The unique identifier of the application. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints. |
| entityId | string <= 255 characters Example: entityId=test-entity The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints. If no entity is associated with this resource, set the entityId to |
| resourceId required | string <= 255 characters Example: resourceId=test-resource The unique identifier of the resource. It depends on both the |
Responses
OK
Unauthorized
Forbidden
Not Found
Too Many Requests
Internal Server Error
Request samples
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
curl -L -g 'https://{baseUrl}/provisioning/1/associations/single?resourceType=%7BresourceType%7D&channel=%7Bchannel%7D&applicationId=test-application&entityId=test-entity&resourceId=test-resource' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json'
Response samples
- 200
- 401
- 403
- 404
- 429
- 500
{- "resourceType": "NUMBER",
- "channel": "SMS",
- "applicationId": "test-application",
- "entityId": "test-entity",
- "resourceId": "test-resource"
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See
Service status'%3E %3Cpath d='M11.9047 8.47667L19.3513 0H17.5873L11.1187 7.35867L5.956 0H0L7.80867 11.1287L0 20.0167H1.764L8.59067 12.244L14.044 20.0167H20M2.40067 1.30267H5.11067L17.586 18.778H14.8753' fill='%23424B5C'/%3E %3C/g%3E %3Cdefs%3E %3CclipPath id='clip0_3438_1744'%3E %3Crect width='20' height='20.0167' fill='white'/%3E %3C/clipPath%3E %3C/defs%3E %3C/svg%3E)
