Phone Numbers

Submit A2P 10DLC registration

Submit the organisation to the US carrier registry. THIS REACHES A THIRD PARTY AND CARRIES CARRIER FEES.

Saves the inputs, then starts a durable registration saga and returns its workflow_id immediately - registration takes days, not seconds, and the carriers can reject it. Without an approved registration, US carriers filter application-to-person SMS from these numbers, so this is not optional for messaging.

IDEMPOTENT PER ORGANISATION: the workflow id is derived from the org, so a second call while one is running is a no-op rather than a second submission. Call /a2p/inputs first if you only want to save a draft.

post/phone-numbers/a2p/register

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/phone-numbers/a2p/register
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

brand_inputsobject

The legal business behind the messages: legal_business_name (required before registration can start), plus ein, address, website, business_type, vertical and whatever else the carrier registry asks for.

campaign_inputsobject

What the messages are: use_case, message_samples and opt_in_method are the three the platform checks for before it considers the inputs complete.

Response

Successful Response

dataPhoneNumberPayload required

An open envelope for a purchase result, a release, or an A2P job.

Open on purpose. A purchase returns the stored row (whose capability and provider-metadata keys differ per provider), a workflow start returns a workflow_id, and the A2P reconcile returns per-number outcomes that grow as carriers add statuses. Pinning it would silently drop whatever the provider reported that this contract had not caught up on.

Changes

No recorded changes to this operation across all 2 revisions of this API.