Get the A2P registration
curl --request GET \
--url https://dev-public-api.openphone.dev/a2p-registration \
--header 'Authorization: <api-key>' \
--header 'Quo-Api-Version: <quo-api-version>'{
"data": {
"id": "RG123abc",
"draft": true,
"status": "pending",
"statusMessages": [
{
"errorCode": 123,
"errorReason": "<string>",
"fieldName": "<string>",
"fields": [
"<string>"
]
}
],
"type": "standard",
"assignedPnId": "<string>",
"firstSubmittedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"businessInfo": {
"name": "Acme Inc",
"alternateName": "<string>",
"businessType": "Limited Liability Corporation",
"companyType": "Private",
"industry": "<string>",
"employeeCount": 123,
"avgDailyCallVolume": 123,
"regionsOfOperation": [
"Africa"
],
"websiteUrl": "<string>",
"useOpHostedPrivacyPolicy": true,
"idType": "USA: Employer Identification Number (EIN)",
"idNumber": "<string>",
"ticker": "<string>",
"exchange": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "US"
},
"personOfContact": {
"firstName": "<string>",
"lastName": "<string>",
"jobTitle": "<string>",
"jobPosition": "<string>",
"email": "jsmith@example.com",
"phoneNumber": "<string>"
}
},
"messaging": {
"useCase": "<string>",
"description": "<string>",
"samples": [
"<string>"
],
"flow": "<string>",
"personalUse": true,
"consent": {
"digitalForm": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"mobileApp": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"onSite": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"other": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"physicalForm": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"textMessage": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"verbal": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"websiteForm": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"written": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
}
}
}
}
}{
"message": "The input was invalid",
"docs": "https://quo.com/docs",
"title": "Bad Request",
"trace": "6897907457496870895"
}{
"message": "User is unauthorized to perform this action",
"docs": "https://quo.com/docs",
"title": "Unauthorized",
"trace": "6897907457496870895"
}{
"message": "User is forbidden to perform this action",
"docs": "https://quo.com/docs",
"title": "Forbidden",
"trace": "6897907457496870895"
}{
"message": "The organization has no A2P registration",
"docs": "https://quo.com/docs",
"title": "Not Found",
"trace": "6897907457496870895"
}{
"message": "An unknown error has occurred",
"docs": "https://quo.com/docs",
"title": "Unknown Error",
"trace": "6897907457496870895"
}A2P Registration
Get the A2P registration
Get the organization’s A2P (10DLC) registration. Organizations have at most one registration. Returns a 404 rather than a null data field when no registration exists yet.
GET
/
a2p-registration
Get the A2P registration
curl --request GET \
--url https://dev-public-api.openphone.dev/a2p-registration \
--header 'Authorization: <api-key>' \
--header 'Quo-Api-Version: <quo-api-version>'{
"data": {
"id": "RG123abc",
"draft": true,
"status": "pending",
"statusMessages": [
{
"errorCode": 123,
"errorReason": "<string>",
"fieldName": "<string>",
"fields": [
"<string>"
]
}
],
"type": "standard",
"assignedPnId": "<string>",
"firstSubmittedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"businessInfo": {
"name": "Acme Inc",
"alternateName": "<string>",
"businessType": "Limited Liability Corporation",
"companyType": "Private",
"industry": "<string>",
"employeeCount": 123,
"avgDailyCallVolume": 123,
"regionsOfOperation": [
"Africa"
],
"websiteUrl": "<string>",
"useOpHostedPrivacyPolicy": true,
"idType": "USA: Employer Identification Number (EIN)",
"idNumber": "<string>",
"ticker": "<string>",
"exchange": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "US"
},
"personOfContact": {
"firstName": "<string>",
"lastName": "<string>",
"jobTitle": "<string>",
"jobPosition": "<string>",
"email": "jsmith@example.com",
"phoneNumber": "<string>"
}
},
"messaging": {
"useCase": "<string>",
"description": "<string>",
"samples": [
"<string>"
],
"flow": "<string>",
"personalUse": true,
"consent": {
"digitalForm": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"mobileApp": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"onSite": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"other": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"physicalForm": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"textMessage": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"verbal": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"websiteForm": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
},
"written": {
"enabled": true,
"askForConsentExample": "<string>",
"screenshotUrl": "<string>",
"storeUrl": "<string>",
"text": "<string>",
"url": "<string>"
}
}
}
}
}{
"message": "The input was invalid",
"docs": "https://quo.com/docs",
"title": "Bad Request",
"trace": "6897907457496870895"
}{
"message": "User is unauthorized to perform this action",
"docs": "https://quo.com/docs",
"title": "Unauthorized",
"trace": "6897907457496870895"
}{
"message": "User is forbidden to perform this action",
"docs": "https://quo.com/docs",
"title": "Forbidden",
"trace": "6897907457496870895"
}{
"message": "The organization has no A2P registration",
"docs": "https://quo.com/docs",
"title": "Not Found",
"trace": "6897907457496870895"
}{
"message": "An unknown error has occurred",
"docs": "https://quo.com/docs",
"title": "Unknown Error",
"trace": "6897907457496870895"
}Was this page helpful?