INinfobip
channels
rcs
rcs-service-management
rcs-sender-management

Get RCS sender

Get a single RCS sender by sender name.

get/rcs/1/senders/{senderName}

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

Sender identifier.

Response

RCS sender

senderNamestring required

Unique identifier of Sender entity for RCS channel within Infobip platform.

senderStatus'DRAFT' | 'PENDING' | 'READY_FOR_TESTING' | 'PENDING_LAUNCH' | 'SENDER_UPDATE_REQUIRED' | 'LAUNCHED_IN_PROGRESS' | 'LAUNCHED_PARTIAL_SUCCESS' | 'LAUNCHED' required

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

  • DRAFT: Status returned when the Sender is created in Draft state via the UI.
  • PENDING: Status returned while the creation or update of the Sender is being processed.
  • READY_FOR_TESTING: Status indicating that the Sender has been created, is unlocked for editing, and testing is allowed on any device. If the launch process finishes unsuccessfully (i.e., all Providers have REJECTED), the Sender reverts to this status.
  • PENDING_LAUNCH: Status indicating that a launch has been requested through the Account Manager, RR (future), or CUP UI (future). The Sender is locked and cannot be edited.
  • SENDER_UPDATE_REQUIRED: Status indicating that after PENDING_LAUNCH, an update to the Sender is required. The Sender is unlocked for editing.
  • LAUNCHED_IN_PROGRESS: Status indicating that at least one Provider has successfully COMPLETED the launch of the Sender. The Sender is locked and ready for sending traffic, but the launch process with all Providers is not yet complete.
  • LAUNCHED_PARTIAL_SUCCESS: Status indicating that all Providers have completed their launch process with mixed results — some Providers have COMPLETED successfully, and others have REJECTED. The Sender remains locked and can be used for sending traffic.
  • LAUNCHED: Status indicating that all selected Providers have successfully COMPLETED the launch of the Sender.
billingCategory'CONVERSATIONAL' | 'NON_CONVERSATIONAL' required

Billing category for the sender. Following billing categories are available:

  • NON_CONVERSATIONAL: Messages billed as standard RCS message that allows richer messaging experience. Never billed as CONVERSATIONAL.
  • CONVERSATIONAL: Billed as session in which user and agent can exchange a series of messages.
useCase'OTP' | 'TRANSACTIONAL' | 'PROMOTIONAL' | 'MULTI_USE' required

Use case for the sender. Following use cases are available:

  • OTP: Used for senders that only send one time passwords.
  • TRANSACTIONAL: Used for senders that send only essential, necessary and time-sensitive messages.
  • PROMOTIONAL: Used for senders that send promotional messages.
  • MULTI_USE: Used for senders that have multiple use cases.
hostingRegion'NORTH_AMERICA' | 'EUROPE' | 'ASIA_PACIFIC' required

RBM agents can be hosted in one of three regions: North America, Europe, or Asia Pacific, to help businesses comply with regional and regulatory requirements. Select the region based on the country where you plan to launch the sender. Please note that the hosting region cannot be changed once the sender is created.

googleAgentIdstring

Google Agent ID associated with this sender.

displayNamestring required

The name of the sender displayed to the user on mobile device.

descriptionstring required

The description of the sender displayed to the user on mobile device.

colorstring required

Theme color of the sender that is visible to the user on mobile device. Must be in hex format and contrast ratio must be at least 4.5:1 for white.

bannerUrlstring required

URL of the banner image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 1440 x 448 resolution (width x height). Maximum 204,800 bytes. Maximum URL length is 2048 characters.

logoUrlstring required

URL of the logo image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 224 x 224 resolution (width x height). Maximum 51,200 bytes. Maximum URL length is 2048 characters.

updatedAtstring date-time required

Timestamp when sender has been updated last time. (ISO 8601-style timestamp)

Changes

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