RingCentral Notifications

Overview

• Source: https://ringcentral.com
• Image Support: No
• Attachment Support: Yes
• Message Character Limits:
  • Body: 160
• Build Your Apprise URL

Account Setup

1. Sign up at https://ringcentral.com.
2. Log in to the RingCentral Developer Console.
3. Click Create App and choose REST API App -> Server/Bot (No UI).
4. Under Permissions, enable SMS and MMS (MMS is required for attachment support).
5. On the Credentials tab, copy the Client ID and Client Secret.

Two authentication modes are supported:

BASIC mode (username + password)

Use the RingCentral user account password associated with your source phone number. This is the simpler option when you do not want to manage JWT tokens.

JWT mode

Generate a JWT token in the developer portal and use it in place of the password. JWT tokens are longer (> 60 characters) and Apprise auto-detects this mode when no explicit ?mode= is provided.

Attachments

When an attachment is included with a notification, Apprise automatically switches to the MMS endpoint. No extra configuration is needed — SMS is used for plain messages and MMS is used when files are attached.

Syntax

Valid syntax is as follows:

• ringc://{SourcePhoneNo}:{Password}@{ClientID}/{ClientSecret}
• ringc://{SourcePhoneNo}:{Password}@{ClientID}/{ClientSecret}/{ToPhoneNo}
• ringc://{SourcePhoneNo}:{Password}@{ClientID}/{ClientSecret}/{To1}/{To2}/{ToN}
• ringc://{SourcePhoneNo}:{JWTToken}@{ClientID}/{ClientSecret}
• ringc://{SourcePhoneNo}:{JWTToken}@{ClientID}/{ClientSecret}/{ToPhoneNo}

You can also supply credentials as query parameters (useful in YAML config files):

• ringc://_?token={TokenOrPassword}&secret={ClientSecret}&from={SourcePhoneNo}
• ringc://_?token={TokenOrPassword}&secret={ClientSecret}&from={SourcePhoneNo}&to={ToPhoneNo}

If no target phone number is provided, the notification is sent to the source phone number itself (useful for testing).

Parameter Breakdown

Variable	Required	Description
SourcePhoneNo	*Yes	The RingCentral phone number to send from. Must be associated with your account.
Password	*Yes	The RingCentral user password (BASIC mode) or JWT token (JWT mode).
ClientID	*Yes	The Client ID from the RingCentral developer portal app credentials.
ClientSecret	*Yes	The Client Secret from the RingCentral developer portal app credentials.
ToPhoneNo	No	One or more destination phone numbers. If omitted, the source phone is used.
to	No	Alias for the target phone number(s); accepts comma-separated values.
from	No	Alias for the source phone number; useful in query-parameter form.
source	No	Alias for from.
token	No	Query-parameter alias for the password or JWT token.
secret	No	Query-parameter alias for the Client Secret.
mode	No	Force authentication mode: basic or jwt. Auto-detected from token length when omitted.
env	No	API environment: prod (default) or sandbox (RingCentral devtest).

Global Parameters

Variable	Description
overflow	This parameter can be set to either split, truncate, or upstream. This determines how Apprise delivers the message you pass it. By default this is set to upstream 👉 upstream: Do nothing at all; pass the message exactly as you received it to the service. 👉 truncate: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated. 👉 split: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after.
format	This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verify	External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes.
redirect	By default, Apprise will follow HTTP redirects (3xx responses) issued by the remote server, matching the behaviour of the underlying requests library. If you want to prevent custom headers and credentials from being forwarded to destinations that differ from the original URL, set this to no. By default it is set to yes.
cto	This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rto	This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojis	Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tz	Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area.
retry	The number of additional delivery attempts to make after the first failure before giving up. Accepts an integer in the range 0 to 10. The default is 0 (no retries — a single attempt is made). When combined with wait, Apprise pauses the specified number of seconds between each attempt.
wait	The number of seconds to pause between retry attempts. Accepts a decimal value in the range 0.0 to 20.0; integer values are promoted to float automatically. The default is 0.5. This value is only meaningful when retry is greater than zero — a service with retry=0 makes exactly one attempt regardless of the wait value.
optional	When set to yes, a delivery failure for this service is silently absorbed. The overall notify() call still returns True even if this endpoint was unreachable, provided that every required (non-optional) service in the same batch succeeded. Setting this flag does not skip delivery or bypass retry logic — all configured retry attempts are still made before the failure is absorbed. By default this is set to no, meaning every failure is propagated to the caller.

Examples

Send a BASIC mode SMS:

# Assuming SourcePhoneNo is +15551230000
# Assuming Password is MyPassword
# Assuming ClientID is AbCdEf123
# Assuming ClientSecret is secret123
# Assuming ToPhoneNo is +15559998888
apprise -vv -t "Test Title" -b "Test Message" \
    "ringc://15551230000:MyPassword@AbCdEf123/secret123/15559998888"

Send a JWT mode SMS to multiple recipients:

apprise -vv -t "Test Title" -b "Test Message" \
    "ringc://15551230000:eyJhbGciOiJSUzI1NiJ9...@AbCdEf123/secret123/15559998881/15559998882"

Send an MMS with an attachment (MMS is selected automatically):

apprise -vv -t "Test Title" -b "Test Message" \
    --attach /path/to/image.jpg \
    "ringc://15551230000:MyPassword@AbCdEf123/secret123/15559998888"

Send using query parameters (YAML-friendly form):

apprise -vv -t "Test Title" -b "Test Message" \
    "ringc://_?token=MyPassword&secret=secret123&from=15551230000&to=15559998888"