Cancel Number Subscription · Engagement Platform API

type

string

The type of the number.

Possible values: local, national, tollfree, mobile, shortcode

capabilities

object

The capabilities of the number.

Mostra attributi secondari

capabilities.sms

object

obbligatorio

Mostra attributi secondari

capabilities.sms.inbound

boolean

obbligatorio

Whether the number supports inbound use cases.

capabilities.sms.outbound

boolean

obbligatorio

Whether the number supports outbound use cases.

capabilities.voice

object

obbligatorio

Mostra attributi secondari

capabilities.voice.inbound

boolean

obbligatorio

Whether the number supports inbound use cases.

capabilities.voice.outbound

boolean

obbligatorio

Whether the number supports outbound use cases.

capabilities.mms

object

obbligatorio

Mostra attributi secondari

capabilities.mms.inbound

boolean

obbligatorio

Whether the number supports inbound use cases.

capabilities.mms.outbound

boolean

obbligatorio

Whether the number supports outbound use cases.

capabilities.fax

object

obbligatorio

Mostra attributi secondari

capabilities.fax.inbound

boolean

obbligatorio

Whether the number supports inbound use cases.

capabilities.fax.outbound

boolean

obbligatorio

Whether the number supports outbound use cases.

capabilities.whatsapp

object

Mostra attributi secondari

capabilities.whatsapp.inbound

boolean

obbligatorio

Whether the number supports inbound use cases.

capabilities.whatsapp.outbound

boolean

obbligatorio

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.

Mostra attributi secondari

monthlyRecurringPrice.currencyCode

string

obbligatorio

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

obbligatorio

monthlyRecurringPrice.exponent

integer

obbligatorio

Usually a negative number to specify the exponent for decimal precision. e.g., 1540 * (10^-2) = 15.4

complianceRequirements

array of object

Mostra attributi secondari

complianceRequirements.name

string

obbligatorio

complianceRequirements.type

string

obbligatorio

Possible values: kycForm, useCase, whatsappVerification

complianceRequirements.scope

string

obbligatorio

Possible values: number-activation, sms-outbound, whatsapp

complianceRequirements.selector

object

Mostra attributi secondari

complianceRequirements.selector.scope

string

obbligatorio

complianceRequirements.selector.numberType

string

obbligatorio

The type of the number.

Possible values: local, national, tollfree, mobile, shortcode

complianceRequirements.selector.countryCode

string

obbligatorio

The country code in ISO 3166-1 alpha-2 format.

complianceRequirements.inventoryId

string

id

string

obbligatorio

The ID of the number.

status

string

obbligatorio

The status of the number.

Possible values: active, inactive

subscription

object

Describes status of Number Subscription

Mostra attributi secondari

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

Mostra attributi secondari

endpointSubscription.id

string

obbligatorio

The subscription unique identifier.

endpointSubscription.correlationId

string

obbligatorio

The correlation links the subscription to its number. Hence, the correlationId is the numberId.

endpointSubscription.status

string

obbligatorio

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

Mostra attributi secondari

configurations.voice

object

Mostra attributi secondari

configurations.voice.inbound

object

Mostra attributi secondari

configurations.voice.inbound.connectorId

string

configurations.voice.inbound.connectorTemplateId

string

configurations.voice.inbound.connectorTemplateRef

string

configurations.voice.outbound

object

Mostra attributi secondari

configurations.voice.outbound.connectorId

string

configurations.voice.outbound.connectorTemplateId

string

configurations.voice.outbound.connectorTemplateRef

string

configurations.sms

object

Mostra attributi secondari

configurations.sms.inbound

object

Mostra attributi secondari

configurations.sms.inbound.connectorId

string

configurations.sms.inbound.connectorTemplateId

string

configurations.sms.inbound.connectorTemplateRef

string

configurations.sms.outbound

object

Mostra attributi secondari

configurations.sms.outbound.connectorId

string

configurations.sms.outbound.connectorTemplateId

string

configurations.sms.outbound.connectorTemplateRef

string

configurations.mms

object

Mostra attributi secondari

configurations.mms.inbound

object

Mostra attributi secondari

configurations.mms.inbound.connectorId

string

configurations.mms.inbound.connectorTemplateId

string

configurations.mms.inbound.connectorTemplateRef

string

configurations.mms.outbound

object

Mostra attributi secondari

configurations.mms.outbound.connectorId

string

configurations.mms.outbound.connectorTemplateId

string

configurations.mms.outbound.connectorTemplateRef

string

configurations.fax

object

Mostra attributi secondari

configurations.fax.inbound

object

Mostra attributi secondari

configurations.fax.inbound.connectorId

string

configurations.fax.inbound.connectorTemplateId

string

configurations.fax.inbound.connectorTemplateRef

string

configurations.fax.outbound

object

Mostra attributi secondari

configurations.fax.outbound.connectorId

string

configurations.fax.outbound.connectorTemplateId

string

configurations.fax.outbound.connectorTemplateRef

string

configurations.whatsapp

object

Mostra attributi secondari

configurations.whatsapp.connectorId

string

configurations.whatsapp.connectorTemplateId

string

configurations.whatsapp.connectorTemplateRef

string

createdAt

string

obbligatorio

Timestamp (UTC) when the number was created.

updatedAt

string

obbligatorio

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

Mostra attributi secondari

requirements.requirement

object

obbligatorio

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.

Mostra attributi secondari

requirements.requirement.name

string

obbligatorio

requirements.requirement.type

string

obbligatorio

Possible values: kycForm, useCase, whatsappVerification

requirements.requirement.scope

string

obbligatorio

Possible values: number-activation, sms-outbound, whatsapp

requirements.requirement.selector

object

Mostra attributi secondari

requirements.requirement.selector.scope

string

obbligatorio

requirements.requirement.selector.numberType

string

obbligatorio

The type of the number.

Possible values: local, national, tollfree, mobile, shortcode

requirements.requirement.selector.countryCode

string

obbligatorio

The country code in ISO 3166-1 alpha-2 format.

requirements.requirement.inventoryId

string

requirements.status

string

obbligatorio

Possible values: ok, pending, not-valid, not-found, error, no-reference

requirements.reference

string

obbligatorio

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.

Mostra attributi secondari

endpoint.id

string

obbligatorio

The ID of the endpoint.

endpoint.type

string

obbligatorio

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

obbligatorio

The unique identifier of the instance.

endpoint.name

string

obbligatorio

The name of the endpoint. For some cases it will be the number in international format as string.

endpoint.capabilities

array of object

obbligatorio

Mostra attributi secondari

endpoint.capabilities.name

string

obbligatorio

Possible values: sms

endpoint.capabilities.inbound

object

Mostra attributi secondari

endpoint.capabilities.inbound.status

string

obbligatorio

Possible values: active, inactive, available, unavailable

endpoint.capabilities.inbound.issues

array of string

endpoint.capabilities.outbound

object

Mostra attributi secondari

endpoint.capabilities.outbound.status

string

obbligatorio

Possible values: active, inactive, available, unavailable

endpoint.capabilities.outbound.destinationStatuses

object

Mostra attributi secondari

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.

Mostra attributi secondari

endpoint.dependencies.type

string

Possible values: connector

endpoint.dependencies.connectorId

string

obbligatorio

endpoint.dependencies.connectorTemplateRef

string

obbligatorio

endpoint.dependencies.capabilities

array of string

endpoint.issues

array of string

endpoint.provisioningStatus

string

obbligatorio

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.

Mostra attributi secondari

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

obbligatorio

endpoint.updatedAt

string

obbligatorio

object

WhatsApp number pre-verification details.

Mostra attributi secondari

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