Introduction
- 19 Nov 2024
- 1 Minute to read
- Print
- DarkLight
Introduction
- Updated on 19 Nov 2024
- 1 Minute to read
- Print
- DarkLight
Article summary
The Relay Onboarding and Messaging APIs 3.0.0 facilitate the onboarding of Customers or Patients to the Relay platform. If a Customer or Patient is new, they are onboarded; if they already exist, their information is updated. An optional trigger ID can be included to send an experience during onboarding. Each CCID can have up to 50 associated phone numbers, and a single phone number can link to 50 CCIDs. The Messaging API allows for sending experiences to individual or multiple Customers or Patients, with duplicate message suppression in place for messages sent within 15 minutes that share the same CCID and parameters. A maximum of 10 unique messages can be sent to a phone number within 5 minutes, after which the number is blocked from receiving further messages until it is idle for 5 minutes. This ensures efficient communication while managing consent and message frequency.
Did you find this summary helpful?
Thank you for your feedback
Relay Onboarding and Messaging APIs 3.0.0
Onboarding API: This APIs is used to onboard a Customer or Patient to the Relay platform. If the Customer or Patient does not exist, they will be onboarded (added) to the platform. If the Customer or Patient already exists, they will be updated with the new information being provided. The onboarding API can optionally send an experience to the newly onboarded (or updated) Customer or Patient during the same call. This is accomplished by setting the optional trigger_id parameter in the request body.
- A single CCID is permitted to have up to 50 phone numbers associated with it. And a single phone number can be associated with up to 50 CCIDs.
- Enabling Mobile Analysis and strict onboarding configuration will add an extra mobile_analysis_results section to the 200 response body if the result of mobile analysis returns a phone type that is not mobile.
Messaging API: Once the Customer or Patient is onboarded, the Messaging APIs can be used to either trigger an experience being sent to a specific Customer or Patient, but also supports bulk triggering of experiences to multiple Customers or Patients.
- API calls triggering messaging to a different CCID, a different component of the same journey, or calls with distinct input parameters would not constitute a duplicate message.
- Triggering the same message to a CCID which has had any updates to consent on any channels associated with the customer would also allow the message to be sent.
- Only 10 unique messages can be sent to the same phone number within a 5 minute period. Once that limit is reached, the phone number will be blocked from receiving messages until it is idle for 5 minutes (meaning no messages are attempted for 5 minutes), and then messaging can resume.
Servers Staging Environment
https://api.relaystaging.com/platform/v3/apiProduction Environment
https://api.relayzone.com/platform/v3/api
Was this article helpful?