Console Operation Guide

Last updated:2021-12-15
Expand all
Console Operation Guide

Create a Developer Account

Go to the Jiguang official website to create a Jiguang developer account.

Developer Certification

Due to carrier requirements, before using Jiguang SMS services, you need to complete enterprise qualification certification before normal use. All certification information is required. Click to complete developer certification now.

After approval, the information cannot be modified. Fill in the certification information carefully to avoid affecting later use of SMS, verification, and other services.


Create an App

Then start creating an app. After the app is created successfully, you can obtain the unique identifier AppKey of the app. When calling the SMS Rest API, Appkey and MasterSecret are required to complete access authentication.

  • Log in to the Jiguang Developer Service Console, and follow the bubble prompts to click Next.


  • Click Jiguang SMS - Enable Now in the recommended products.

  • Fill in [App Name] and [App Icon], and select [App Category]. [App Name] and [App Category] are required.

  • Click [Go to Configure] on the overview page.

Signature Management

Developers can also create SMS signatures and message body templates under an app. Click to view SMS signature and message body template descriptions.

  • In SMS Management, click Signature Management and find the entry for creating a signature. Created signatures can be queried on this page.

Note: before creating a signature, make sure you understand real-name requirements and filing rules for signatures. If sending fails because of signature-related reasons, contact Jiguang business or customer service for consultation and handling. In addition, signature invalidation is returned directly by carriers, and Jiguang cannot know invalidation information in advance. Please pay attention to sending status yourself.

Create a Signature

  • Signatures support 2 to 16 characters. Spaces or special symbols are not allowed.
  • The signature type can be selected according to the signature source. The supporting document must be consistent with the selected signature type. Currently, only company name and registered valid trademark are supported.alt text

Template Management

  • In SMS Management, click Template Management to view created templates and find the entry for creating message body templates. Jiguang has provided a general template for developers. The general template has passed review and can be used directly.

Create a Template

  • Creating text verification code SMS body templates, system notification SMS body templates, and marketing promotion SMS body templates is supported.

Text Verification Code SMS Body Template

  • The variable name in the body content must be code, in the format {{code}}.
  • The verification code validity period can be entered in the range [0~86400], in seconds.

System Notification SMS Body Template

  • The variable format in the body content is {{key_name}}. The delimiter uses two curly braces. The variable name supports only English letters, numbers, and underscores, and underscores cannot be at the beginning or end.

Marketing Promotion SMS Body Template

  • The variable format in the body content is {{key_name}}. The delimiter uses two curly braces. The variable name supports only English letters, numbers, and underscores, and underscores cannot be at the beginning or end.
  • According to carrier regulations, marketing SMS must contain unsubscribe-related content. The system has added it by default, so you do not need to fill it in the template.

Marketing SMS

  • The Jiguang developer console supports sending marketing SMS online and viewing scheduled and sent marketing SMS records.
  • Creating marketing SMS online does not support uploading variables. To send marketing SMS with variables online, use the batch SMS feature.
  • Before creating a marketing SMS task, make sure the remaining balance is sufficient. If the available balance is less than the number of SMS messages required for this send, the sending task will fail to be created.
  • After a marketing SMS is created successfully, it will be sent only after review approval. If the sending time is set to [Immediate], the SMS will be sent directly after review approval. Users with strict sending time requirements are advised to create scheduled SMS in advance.

Batch SMS

  • The Jiguang developer console supports sending batch system notification SMS and marketing promotion SMS online, and viewing scheduled and sent SMS records.
  • Before using batch SMS to send SMS online, create the template in advance. Batch SMS does not support editing SMS content.
  • Before creating a batch SMS task, make sure the remaining balance is sufficient. If the available balance is less than the number of SMS messages required for this send, the sending task will fail to be created.

View Data

  • Data Overview displays the app data, including SMS balance, sent volume, and consumed volume.
  • Sending records for all types of SMS, including verification code, notification, marketing, and push supplement types, can be viewed in Sending Records.
  • All received uplink SMS records can be viewed in Reply Records.

Resource Management

Go to [Billing Center] - [Resource Management] - [SMS] to view the balance of each SMS type under the account and SMS consumption. Click "Export" to export filtered detailed data.

Resource Allocation

Click "Allocate" to allocate the account balance to the corresponding app.

  • Select the app that needs allocation.
  • Select the SMS type to allocate and fill in the quantity to allocate. The allocated quantity cannot exceed the unallocated total.
  • If an app needs balances of multiple SMS types, click "Confirm", then select "Allocate" again to allocate another type.

Resource Return

If an app no longer needs to use SMS services or has been removed, it is recommended to return the allocated balance and delete the allocation record.

View Operation Logs

If you need to view operation records for allocating and returning resources, click "Operation Logs".

Set Balance Alerts

Go to [Billing Center] - [Resource Management] - [SMS] - [Alert Settings] to configure basic settings and alert settings.

Basic Settings

The Basic Settings page can configure alert sending methods and the contact list for receiving alerts.

  • SMS and email sending methods are supported. At least one sending method must be selected.
  • For each sending method, 1 to 10 contacts can be added.
  • The console selects SMS and email sending methods by default, and displays the mobile number and email from developer certification in the recipient list.

Alert Settings

Default alerts and custom alerts are supported. Choose one of the two alert methods. The console enables default alerts by default.

Default Alert

  • Every day at 10:00 AM, the Jiguang backend calculates whether the current balance can meet the consumption required for the next 14, 7, and 3 days based on the average consumption over the past 30 days. If the balance is insufficient, a balance alert is sent to the mobile number and email used for developer certification.
  • If resources have been allocated to apps, alerts are sent by app (appkey). If no resource allocation exists, alerts are sent by account.
  • Path to disable default alert: click "Edit" - turn off the switch - click "Save".

Custom Alert

  • Calculation is performed every day at 10:00 AM. When the balance of any SMS type under the account/app is lower than the configured threshold, an alert reminder is sent to recipients. At most one SMS and one email are sent per day, and reminders continue for at most 3 consecutive days.

  • Balance threshold settings are supported for 4 types: industry SMS, marketing SMS, voice SMS, and special marketing SMS. The threshold range is 100 to 999999999.

  • Path to set custom alert: select "Custom Alert" - click "Enable" - set balance alert thresholds for each type - click "Save".

  • Path to disable custom alert: click "Edit" - turn off the switch - click "Save".

Was this document helpful?

Copyright 2011-2026, jiguang.cn, All Rights Reserved. 粤ICP备12056275号-13 Shenzhen Hexun Huagu Information Technology Co., Ltd.

Open in Docs Center