Skip to content
DashboardGet API key

List campaign phone number assignments

View .md
GET

List phone numbers assigned to a 10DLC campaign. A number that was unassigned is no longer listed.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • campaignIdstringrequired

    10DLC campaign ID.

Query parameters

  • limitinteger
    Default50
    Limitsmax 100
  • cursorstring

    Opaque cursor from a previous response's nextCursor.

Responses

200List of phone number assignments.
  • itemsobject[]required
    8 properties
    • idstringrequired
    • campaignIdstringrequired
    • phoneNumberIdstringrequired
    • statusstringrequired

      Assignment status. pending: sent to the carrier, not confirmed yet. active: the number is on the campaign and can send. failed: the carrier refused it; see failureReason. The number is free to be assigned again.

      One ofpendingactivefailed
    • failureReasonstringnullable
    • assignedAtstring<date-time>nullable
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
  • nextCursorstringnullable
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Campaign not found.
  • codestringrequired
  • messagestringrequired
  • detailsobject