INinfobip
channels
rcs
rcs-service-management
rcs-test-number-management

Add RCS test number

Add test number for given RCS sender. Invitation to become tester will be sent to given number and once user accepts invitation it will be possible to send test traffic to given test number using given sender. Please note that following limits will apply when adding test number for RCS sender:

  • It is allowed to add up to 20 test numbers per sender per day.
  • It is allowed to add up to 200 test number per sender in total.
post/rcs/1/senders/{senderName}/test-numbers

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Path parameters

senderNamestring required

Identifier of a sender for which test number is requested.

Request body

testNumberstring required

Full number in E.164 format, e.g. +1234567890. Leading '+' is optional.

primaryboolean

Set this test number as primary for this sender. A test number can only be primary for one sender, although a sender may have multiple numbers marked as primary; selecting it here will remove the primary flag from any sender where it is already marked as such. Relevant when multiple senders share the same Application and Entity via Resource Association.

Response

Request has been accepted and result of add test number operation will be sent to webhook

senderNamestring required

Unique identifier of a sender for which test number is associated.

testNumberstring required

Full number in E.164 format, e.g. +1234567890. Leading '+' is optional.

status'PENDING' | 'WAITING_FOR_TESTER_ACCEPTANCE' | 'APPROVED' | 'EXPIRED' | 'UNSUPPORTED' | 'FAILED' required

Status of the test number. It'll be updated by Infobip platform automatically and notification about test number status update will be sent to client's webhook. Following statuses are available:

  • PENDING: Test device registration is pending until 3rd party action will be executed.
  • WAITING_FOR_TESTER_ACCEPTANCE: Waiting for user to accept request to become a tester.
  • APPROVED: User has accepted to become a tester and test messages can be sent to that number.
  • EXPIRED: If user does not accept invitation within 24h, status of test number will be moved to EXPIRED.
  • UNSUPPORTED: Test number is not supported for RCS traffic.
  • FAILED: Failed mostly because of some internal service error during request processing. Please contact support.

Changes

No recorded changes to this operation across all 1 revision of this API.