Skip to main content
GET
/
projects
/
{projectId}
/
imessage
/
shared
/
availability
Check shared phone number availability
curl --request GET \
  --url https://spectrum.photon.codes/projects/{projectId}/imessage/shared/availability
{
  "succeed": true,
  "data": {
    "available": true
  }
}

Path Parameters

projectId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

phoneNumber
string<e164>
required
Pattern: ^\+[1-9]\d{6,14}$

Response

200 - application/json

Response for status 200

succeed
boolean
required
data
object
required