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

Refresh RCS test number

Status of RCS test number is automatically refreshed for 24 hours after it was added. If user does not accept invitation to become a tester in that period, test number will be marked as EXPIRED. Use this endpoint in order to start new 24 hours cycle in which system will periodically check if user has accepted to become a tester.

put/rcs/1/senders/{senderName}/test-numbers/{testNumber}/refresh

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.

testNumberstring required

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

Response

Request has been accepted and result of refresh 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.