Route a new user to the best dedicated iMessage line

curl --request GET \
  --url https://spectrum.photon.codes/projects/{projectId}/lines/route

{
  "succeed": true,
  "data": {
    "line": {
      "platform": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phoneNumber": "<string>",
      "createdAt": "<string>"
    },
    "isBestAvailable": true
  }
}

lines

Route a new user to the best dedicated iMessage line

Returns the single best dedicated iMessage line to assign a new user to, load-balancing by active user count and recent growth. isBestAvailable is false when the returned line is the least-bad fallback — it holds more than 500 users or grew by more than 100 users in the last 10 minutes, meaning no genuinely healthy line was available. Returns 404 if the project owns no dedicated iMessage lines. Requires Authorization: Basic base64(projectId:projectSecret).

GET

projects

{projectId}

lines

route

Route a new user to the best dedicated iMessage line

curl --request GET \
  --url https://spectrum.photon.codes/projects/{projectId}/lines/route

{
  "succeed": true,
  "data": {
    "line": {
      "platform": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phoneNumber": "<string>",
      "createdAt": "<string>"
    },
    "isBestAvailable": 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)$

Response

200 - application/json

Response for status 200

succeed

boolean

required

data

object

required

Show child attributes

Add a dedicated iMessage line

Remove a dedicated line

⌘I