Skip to main content

malipopaysmsservice_WabaPhoneNumber

A number you can send from.

_idstring

Pass this as id on the phone-number routes.

msisdnstring

The local number. This is what you pass as from when sending.

Example: 255687128012
displayPhoneNumberstring

As Meta formats it. Display only: address the number by msisdn.

Example: +255 687 128 012
phoneNumberIdstring

Meta's opaque id for the same number. Accepted when sending, but prefer msisdn.

Example: 1185569601305427
verifiedNamestring

The name customers see.

Example: Your Business
ownershipstring

OWNED is yours. GRANTED is one shared with you. SHARED_PLATFORM is the Malipopay number, usable as a fallback until you connect your own, in which case your customers see MALIPOPAY rather than your brand.

Possible values: [OWNED, GRANTED, SHARED_PLATFORM]

isDefaultSenderboolean

The number used when you send without naming a from.

connectionStatusstring

CONNECTED can send. Anything else is still being set up.

nameStatusstring

Meta reviews the display name separately, and can decline it.

Possible values: [NONE, AVAILABLE, PENDING_REVIEW, APPROVED, DECLINED]

codeVerificationStatusstring

Possible values: [NOT_VERIFIED, VERIFIED, EXPIRED]

qualityRatingstring

Possible values: [GREEN, YELLOW, RED, UNKNOWN]

webhookUrlstringnullable

Where inbound messages and delivery statuses for this number are delivered.

malipopaysmsservice_WabaPhoneNumber
{
"_id": "string",
"msisdn": "255687128012",
"displayPhoneNumber": "+255 687 128 012",
"phoneNumberId": "1185569601305427",
"verifiedName": "Your Business",
"ownership": "OWNED",
"isDefaultSender": true,
"connectionStatus": "string",
"nameStatus": "NONE",
"codeVerificationStatus": "NOT_VERIFIED",
"qualityRating": "GREEN",
"webhookUrl": "string"
}