Cancel Number Subscription
"Cancel Number Subscription" API endpoint is deprecated, we suggest you to use . APIs to cancel the subscription. You can use numberId as endpointId parameter and use main as a subscription name to achieve identical behavior.
POST
/workspaces/{workspaceId}/numbers/{numberId}/cancel-subscription
Cancel Number Subscription
Antwort-Payload
type
string
The type of the number.
Possible values: local, national, tollfree, mobile, shortcode
capabilities
object
The capabilities of the number.
Untergeordnete Attribute anzeigen
capabilities.sms
object
erforderlich
Untergeordnete Attribute anzeigen
capabilities.sms.inbound
boolean
erforderlich
Whether the number supports inbound use cases.
capabilities.sms.outbound
boolean
erforderlich
Whether the number supports outbound use cases.
capabilities.voice
object
erforderlich
Untergeordnete Attribute anzeigen
capabilities.voice.inbound
boolean
erforderlich
Whether the number supports inbound use cases.
capabilities.voice.outbound
boolean
erforderlich
Whether the number supports outbound use cases.
capabilities.mms
object
erforderlich
Untergeordnete Attribute anzeigen
capabilities.mms.inbound
boolean
erforderlich
Whether the number supports inbound use cases.
capabilities.mms.outbound
boolean
erforderlich
Whether the number supports outbound use cases.
capabilities.fax
object
erforderlich
Untergeordnete Attribute anzeigen
capabilities.fax.inbound
boolean
erforderlich
Whether the number supports inbound use cases.
capabilities.fax.outbound
boolean
erforderlich
Whether the number supports outbound use cases.
capabilities.whatsapp
object
Untergeordnete Attribute anzeigen
capabilities.whatsapp.inbound
boolean
erforderlich
Whether the number supports inbound use cases.
capabilities.whatsapp.outbound
boolean
erforderlich
Whether the number supports outbound use cases.
number
string
The phone number in E.164 format.
country
string
monthlyRecurringPrice
object
Money combines an amount of money with its currency.
Untergeordnete Attribute anzeigen
monthlyRecurringPrice.currencyCode
string
erforderlich
Currency as ISO 4217 code (three digits). An example would be EUR for Euro.
Possible values: EUR, USD, GBP, AUD, SGD, IDR, INR, MXN
monthlyRecurringPrice.amount
integer
erforderlich
monthlyRecurringPrice.exponent
integer
erforderlich
Usually a negative number to specify the exponent for decimal precision. e.g., 1540 * (10^-2) = 15.4
complianceRequirements
array of object
Untergeordnete Attribute anzeigen
complianceRequirements.name
string
erforderlich
complianceRequirements.type
string
erforderlich
Possible values: kycForm, useCase, whatsappVerification
complianceRequirements.scope
string
erforderlich
Possible values: number-activation, sms-outbound, whatsapp
complianceRequirements.selector
object
Untergeordnete Attribute anzeigen
complianceRequirements.selector.scope
string
erforderlich
complianceRequirements.selector.numberType
string
erforderlich
The type of the number.
Possible values: local, national, tollfree, mobile, shortcode
complianceRequirements.selector.countryCode
string
erforderlich
The country code in ISO 3166-1 alpha-2 format.
complianceRequirements.inventoryId
string
id
string
erforderlich
The ID of the number.
status
string
erforderlich
The status of the number.
Possible values: active, inactive
subscription
object
Describes status of Number Subscription
Untergeordnete Attribute anzeigen
subscription.status
string
The status of the accounting subscription. It can be none, active, canceling, canceled, or planned.
Possible values: none, active, inactive, canceling, canceled, planned
subscription.subscribedAt
string
Timestamp (UTC) when the subscription became active.
subscription.updatedAt
string
Timestamp (UTC) when the subscription was last updated.
subscription.cancelledAt
string
Timestamp (UTC) when the subscription was cancelled.
endpointSubscription
object
Untergeordnete Attribute anzeigen
endpointSubscription.id
string
erforderlich
The subscription unique identifier.
endpointSubscription.correlationId
string
erforderlich
The correlation links the subscription to its number. Hence, the correlationId is the numberId.
endpointSubscription.status
string
erforderlich
The status of the accounting subscription. It can be none, active, canceling, canceled, or planned.
Possible values: none, active, inactive, canceling, canceled, planned
endpointSubscription.subscribedAt
string
The date and time when the subscription was created.
endpointSubscription.updatedAt
string
endpointSubscription.canceledAt
string
The date and time when the subscription was canceled.
endpointSubscription.startAt
string
The date and time when the subscription should start.
endpointSubscription.endAt
string
The date and time when the subscription should end.
configurations
object
Untergeordnete Attribute anzeigen
configurations.voice
object
Untergeordnete Attribute anzeigen
configurations.voice.inbound
object
Untergeordnete Attribute anzeigen
configurations.voice.inbound.connectorId
string
configurations.voice.inbound.connectorTemplateId
string
configurations.voice.inbound.connectorTemplateRef
string
configurations.voice.outbound
object
Untergeordnete Attribute anzeigen
configurations.voice.outbound.connectorId
string
configurations.voice.outbound.connectorTemplateId
string
configurations.voice.outbound.connectorTemplateRef
string
configurations.sms
object
Untergeordnete Attribute anzeigen
configurations.sms.inbound
object
Untergeordnete Attribute anzeigen
configurations.sms.inbound.connectorId
string
configurations.sms.inbound.connectorTemplateId
string
configurations.sms.inbound.connectorTemplateRef
string
configurations.sms.outbound
object
Untergeordnete Attribute anzeigen
configurations.sms.outbound.connectorId
string
configurations.sms.outbound.connectorTemplateId
string
configurations.sms.outbound.connectorTemplateRef
string
configurations.mms
object
Untergeordnete Attribute anzeigen
configurations.mms.inbound
object
Untergeordnete Attribute anzeigen
configurations.mms.inbound.connectorId
string
configurations.mms.inbound.connectorTemplateId
string
configurations.mms.inbound.connectorTemplateRef
string
configurations.mms.outbound
object
Untergeordnete Attribute anzeigen
configurations.mms.outbound.connectorId
string
configurations.mms.outbound.connectorTemplateId
string
configurations.mms.outbound.connectorTemplateRef
string
configurations.fax
object
Untergeordnete Attribute anzeigen
configurations.fax.inbound
object
Untergeordnete Attribute anzeigen
configurations.fax.inbound.connectorId
string
configurations.fax.inbound.connectorTemplateId
string
configurations.fax.inbound.connectorTemplateRef
string
configurations.fax.outbound
object
Untergeordnete Attribute anzeigen
configurations.fax.outbound.connectorId
string
configurations.fax.outbound.connectorTemplateId
string
configurations.fax.outbound.connectorTemplateRef
string
configurations.whatsapp
object
Untergeordnete Attribute anzeigen
configurations.whatsapp.connectorId
string
configurations.whatsapp.connectorTemplateId
string
configurations.whatsapp.connectorTemplateRef
string
createdAt
string
erforderlich
Timestamp (UTC) when the number was created.
updatedAt
string
erforderlich
Timestamp (UTC) when the number was last updated.
activatedAt
string
Timestamp (UTC) of the last time the number was activated.
deactivatedAt
string
Timestamp (UTC) of the last time the number was deactivated.
deactivatesAt
string
Timestamp (UTC) when the number will be deactivated.
requirements
array of object
Untergeordnete Attribute anzeigen
requirements.requirement
object
erforderlich
Compliance requirement for a number. It may be a KYC form, use case, or WhatsApp verification. In some cases, a destination may require multiple compliance requirements to be satisfied to be able to send traffic.
Untergeordnete Attribute anzeigen
requirements.requirement.name
string
erforderlich
requirements.requirement.type
string
erforderlich
Possible values: kycForm, useCase, whatsappVerification
requirements.requirement.scope
string
erforderlich
Possible values: number-activation, sms-outbound, whatsapp
requirements.requirement.selector
object
Untergeordnete Attribute anzeigen
requirements.requirement.selector.scope
string
erforderlich
requirements.requirement.selector.numberType
string
erforderlich
The type of the number.
Possible values: local, national, tollfree, mobile, shortcode
requirements.requirement.selector.countryCode
string
erforderlich
The country code in ISO 3166-1 alpha-2 format.
requirements.requirement.inventoryId
string
requirements.status
string
erforderlich
Possible values: ok, pending, not-valid, not-found, error, no-reference
requirements.reference
string
erforderlich
requirements.notOkSince
string
Timestamp (UTC) when the number didn't meet the requirement.
endpoint
object
A representation of an endpoint. It contains details such as the capabilities, dependencies, and more.
Untergeordnete Attribute anzeigen
endpoint.id
string
erforderlich
The ID of the endpoint.
endpoint.type
string
erforderlich
The type of the endpoint. It can be a long code number, short code number, alpha number, ip pool, or rcs google agent.
Possible values: long-code-number, short-code-number, alpha-number, ip-pool, rcs-google-agent
endpoint.instanceId
string
erforderlich
The unique identifier of the instance.
endpoint.name
string
erforderlich
The name of the endpoint. For some cases it will be the number in international format as string.
endpoint.capabilities
array of object
erforderlich
Untergeordnete Attribute anzeigen
endpoint.capabilities.name
string
erforderlich
Possible values: sms
endpoint.capabilities.inbound
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.inbound.status
string
erforderlich
Possible values: active, inactive, available, unavailable
endpoint.capabilities.inbound.issues
array of string
endpoint.capabilities.outbound
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.outbound.status
string
erforderlich
Possible values: active, inactive, available, unavailable
endpoint.capabilities.outbound.destinationStatuses
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.outbound.destinationStatuses.active
number
endpoint.capabilities.outbound.destinationStatuses.inactive
number
endpoint.capabilities.outbound.destinationStatuses.available
number
endpoint.capabilities.outbound.destinationStatuses.unavailable
number
endpoint.capabilities.outbound.supportsDestinations
boolean
Whether the number supports destinations
endpoint.capabilities.outbound.issues
array of string
endpoint.capabilities.name
string
erforderlich
Possible values: mms
endpoint.capabilities.inbound
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.inbound.status
string
erforderlich
Possible values: active, inactive, available, unavailable
endpoint.capabilities.inbound.issues
array of string
endpoint.capabilities.outbound
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.outbound.status
string
erforderlich
Possible values: active, inactive, available, unavailable
endpoint.capabilities.outbound.destinationStatuses
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.outbound.destinationStatuses.active
number
endpoint.capabilities.outbound.destinationStatuses.inactive
number
endpoint.capabilities.outbound.destinationStatuses.available
number
endpoint.capabilities.outbound.destinationStatuses.unavailable
number
endpoint.capabilities.outbound.supportsDestinations
boolean
Whether the number supports destinations
endpoint.capabilities.outbound.issues
array of string
endpoint.capabilities.name
string
erforderlich
Possible values: voice
endpoint.capabilities.inbound
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.inbound.status
string
erforderlich
Possible values: active, inactive, available, unavailable
endpoint.capabilities.inbound.issues
array of string
endpoint.capabilities.outbound
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.outbound.status
string
erforderlich
Possible values: active, inactive, available, unavailable
endpoint.capabilities.outbound.destinationStatuses
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.outbound.destinationStatuses.active
number
endpoint.capabilities.outbound.destinationStatuses.inactive
number
endpoint.capabilities.outbound.destinationStatuses.available
number
endpoint.capabilities.outbound.destinationStatuses.unavailable
number
endpoint.capabilities.outbound.supportsDestinations
boolean
Whether the number supports destinations
endpoint.capabilities.outbound.issues
array of string
endpoint.capabilities.useCaseType
string
Possible values: contact-centre
endpoint.capabilities.name
string
erforderlich
Possible values: whatsapp
endpoint.capabilities.inbound
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.inbound.status
string
erforderlich
Possible values: active, inactive, available, unavailable
endpoint.capabilities.inbound.issues
array of string
endpoint.capabilities.outbound
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.outbound.status
string
erforderlich
Possible values: active, inactive, available, unavailable
endpoint.capabilities.outbound.destinationStatuses
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.outbound.destinationStatuses.active
number
endpoint.capabilities.outbound.destinationStatuses.inactive
number
endpoint.capabilities.outbound.destinationStatuses.available
number
endpoint.capabilities.outbound.destinationStatuses.unavailable
number
endpoint.capabilities.outbound.supportsDestinations
boolean
Whether the number supports destinations
endpoint.capabilities.outbound.issues
array of string
endpoint.capabilities.name
string
erforderlich
Possible values: email
endpoint.capabilities.inbound
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.inbound.status
string
erforderlich
Possible values: active, inactive, available, unavailable
endpoint.capabilities.inbound.issues
array of string
endpoint.capabilities.outbound
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.outbound.status
string
erforderlich
Possible values: active, inactive, available, unavailable
endpoint.capabilities.outbound.destinationStatuses
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.outbound.destinationStatuses.active
number
endpoint.capabilities.outbound.destinationStatuses.inactive
number
endpoint.capabilities.outbound.destinationStatuses.available
number
endpoint.capabilities.outbound.destinationStatuses.unavailable
number
endpoint.capabilities.outbound.supportsDestinations
boolean
Whether the number supports destinations
endpoint.capabilities.outbound.issues
array of string
endpoint.capabilities.name
string
erforderlich
Possible values: rcs-google
endpoint.capabilities.inbound
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.inbound.status
string
erforderlich
Possible values: active, inactive, available, unavailable
endpoint.capabilities.inbound.issues
array of string
endpoint.capabilities.outbound
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.outbound.status
string
erforderlich
Possible values: active, inactive, available, unavailable
endpoint.capabilities.outbound.destinationStatuses
object
Untergeordnete Attribute anzeigen
endpoint.capabilities.outbound.destinationStatuses.active
number
endpoint.capabilities.outbound.destinationStatuses.inactive
number
endpoint.capabilities.outbound.destinationStatuses.available
number
endpoint.capabilities.outbound.destinationStatuses.unavailable
number
endpoint.capabilities.outbound.supportsDestinations
boolean
Whether the number supports destinations
endpoint.capabilities.outbound.issues
array of string
endpoint.dependencies
array of object
The dependencies of the endpoint. It shows the connectors that the endpoint is connected to.
Untergeordnete Attribute anzeigen
endpoint.dependencies.type
string
Possible values: connector
endpoint.dependencies.connectorId
string
erforderlich
endpoint.dependencies.connectorTemplateRef
string
erforderlich
endpoint.dependencies.capabilities
array of string
endpoint.issues
array of string
endpoint.provisioningStatus
string
erforderlich
Possible values: provisioned, provisioning, deprovisioned, deprovisioning
endpoint.whatsApp
object
WhatsApp pre-verification details for this endpoint, if applicable. Only present for long code numbers from WhatsApp-capable providers.
Untergeordnete Attribute anzeigen
endpoint.whatsApp.whatsAppId
string
endpoint.whatsApp.status
string
WhatsApp number status
Possible values: unknown, already-exists, installed, verified, not-verified, expired
endpoint.whatsApp.stage
string
endpoint.whatsApp.attempt
integer
endpoint.whatsApp.nextAttemptAt
string
endpoint.whatsApp.verificationExpiresAt
string
endpoint.whatsApp.requestedCodeAt
string
endpoint.whatsApp.createdAt
string
endpoint.whatsApp.updatedAt
string
endpoint.createdAt
string
erforderlich
endpoint.updatedAt
string
erforderlich
whatsApp
object
WhatsApp number pre-verification details.
Untergeordnete Attribute anzeigen
whatsApp.whatsAppId
string
whatsApp.status
string
WhatsApp number status
Possible values: unknown, already-exists, installed, verified, not-verified, expired
whatsApp.stage
string
whatsApp.attempt
integer
whatsApp.nextAttemptAt
string
whatsApp.verificationExpiresAt
string
whatsApp.requestedCodeAt
string
whatsApp.createdAt
string
whatsApp.updatedAt
string
Codebeispiel
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/numbers/{numberId}/cancel-subscription' \
-H 'Authorization: AccessKey YOUR_ACCESS_KEY'