Documents

Global bulk business SMS and commercial marketing text messaging built for cross-border B2B outreach. Access full two-way reply features, one-click massdispatch, live task tracking and detailed delivery reports to monitor real-time SMS delivery status. Mar

Try it

Send SMS and track per‑task delivery status via the UpKuaJing Open Platform API.

What it does

Three CLI scripts wrap the UpKuaJing SMS APIs. sms_send.py sends to one or many phone numbers and supports a two‑way channel (--channel_type 1) for receiving replies. sms_task_list.py returns tasks filterable by time range and status. sms_task_record_list.py pulls per‑recipient records for a given task ID, with status values 1‑sending, 2‑completed, 3‑failed, 4‑partial success. Sending is charged per request based on the number of phones; task list and record queries are free. The bundled auth.py handles API key setup, new‑key issuance, balance top‑up, and pricing lookup.

When to use it

  • Send a one‑off or batch SMS to multiple recipients
  • List recent SMS tasks filtered by time range or status
  • Look up per‑recipient delivery results for a specific task
  • Check account balance, apply for a new API key, or top up

The skill document

UpKuaJing SMS Tool

Send SMS and track SMS task status using the UpKuaJing Open Platform API.

Overview

This skill provides access to UpKuaJing's SMS service through:

  • SMS Send (sms_send.py): Send SMS to phone numbers
  • SMS Task List (sms_task_list.py): View SMS task list with time range filter
  • SMS Task Record List (sms_task_record_list.py): View detailed records for a specific task

Running Scripts

Environment Setup

  1. Check Python: python --version
  2. Install dependencies: pip install -r requirements.txt

Script directory: scripts/*.py Run example: python scripts/*.py

Important: Always use direct script invocation like python scripts/sms_send.py. Do NOT use shell compound commands like cd scripts && python sms_send.py.

Three Main APIs

SMS Send (sms_send.py)

Send SMS to phone numbers.

Parameters: See SMS Send API

Examples:

# Send a simple SMS
python scripts/sms_send.py \
  --content "This is SMS content" \
  --phones '["13800138000"]'

# Send with two-way mode (supports receiving replies)
python scripts/sms_send.py \
  --content "This is SMS content" \
  --phones '["13800138000"]' \
  --channel_type 1

# Send to multiple phone numbers
python scripts/sms_send.py \
  --content "This is SMS content" \
  --phones '["13800138000","13800138001"]'

SMS Task List (sms_task_list.py)

View SMS task list with optional time range filter.

Parameters: See SMS Task List API

Examples:

# Get task list (first page, 10 items)
python scripts/sms_task_list.py --page_no 1 --page_size 10

# Filter by time range
python scripts/sms_task_list.py \
  --start_time 1775812273 \
  --end_time 1775900000 \
  --page_no 1 \
  --page_size 10

# Filter by status (0-待发送 1-发送中 2-发送完成)
python scripts/sms_task_list.py --status 2 --page_no 1 --page_size 10

SMS Task Record List (sms_task_record_list.py)

View detailed records for a specific SMS task.

Parameters: See SMS Task Record List API

Examples:

# Get records for task ID 1496
python scripts/sms_task_record_list.py --task_id 1496 --page_no 1 --page_size 10

# Filter by time range and status
python scripts/sms_task_record_list.py \
  --task_id 1496 \
  --start_time 1775812273 \
  --end_time 1775900000 \
  --status 2 \
  --page_no 1 \
  --page_size 10

API Key and UpKuaJing Account

  • API Key: Stored in ~/.upkuajing/.env file as UPKUAJING_API_KEY
  • First check: If not set, prompt user to provide or apply at UpKuaJing Open Platform

API Key Not Set

First check if the ~/.upkuajing/.env file has UPKUAJING_API_KEY; If UPKUAJING_API_KEY is not set, prompt the user to choose:

  1. User has one: User provides it (manually add to ~/.upkuajing/.env file)
  2. User doesn't have one: You can apply using the API (auth.py --new_key), the new key will be automatically saved to ~/.upkuajing/.env Wait for user selection;

Account Top-up

When API response indicates insufficient balance, explain and guide user to top up:

  1. Create top-up order (auth.py --new_rec_order)
  2. Based on order response, send payment page URL to user, guide user to open URL and pay, user confirms after successful payment;

Get Account Information

Use this script to get account information for UPKUAJING_API_KEY: auth.py --account_info

Fees

SMS sending API calls incur fees, different interfaces have different billing methods. Latest pricing: Users can visit Detailed Price Description Or use: python scripts/auth.py --price_info (returns complete pricing for all interfaces)

SMS Send Billing Rules

SMS sending is charged — each send request incurs a fee based on the number of phone numbers.

Task List & Record List Billing Rules

Free of charge — No fees for task list and task record list queries.

Fee Confirmation Principle

Any operation that incurs fees must first inform and wait for explicit user confirmation. Do not execute in the same message as the notification.

Workflow

Decision Guide

User IntentUse API
"Send an SMS"SMS Send
"View my SMS tasks"SMS Task List
"Check SMS delivery status"SMS Task Record List
"Find tasks in a time range"SMS Task List (with start_time/end_time)

SMS Send Flow

  1. Prepare SMS content: content, phone number list
  2. Execute send: Use sms_send.py with appropriate parameters
  3. Get response: API returns task result synchronously

Task Check Flow

  1. View task list: Use sms_task_list.py with optional time filter
  2. Get task ID: From the task list response
  3. View task records: Use sms_task_record_list.py with task_id

Error Handling

  • API key invalid/non-existent: Check UPKUAJING_API_KEY in ~/.upkuajing/.env file
  • Insufficient balance: Guide user to top up
  • Invalid parameters: Must first check the corresponding API documentation in references/ directory, get correct parameter names and formats from documentation, do not guess

API Documentation Reference

  • SMS Send: Check references/sms-send-api.md
  • SMS Task List: Check references/sms-task-list-api.md
  • SMS Task Record List: Check references/sms-task-record-list-api.md

Notes

  • File paths use forward slashes on all platforms
  • Do not guess parameter names, get accurate parameter names and formats from documentation
  • Prohibit outputting technical parameter format: Do not display code-style parameters in responses, convert to natural language
  • Do not estimate or guess fees — use python scripts/auth.py --price_info to get accurate pricing information
  • SMS sending is synchronous submission: The API returns response immediately after submission, but the SMS server processes asynchronously; the status field in response indicates sending status (1-sending 2-completed 3-failed 4-partial success)

Other UpKuaJing skills you might find useful:

  • linkedin-person-search — Search people from the LinkedIn source
  • global-company-person-search — Search people from the global company database
  • linkedin-company-search — Search companies from the LinkedIn source
  • global-company-search — Search companies from the global company database
  • global-company-shareholder — Query shareholder list from the global company database
  • global-company-employee — Query employee list from the global company database
  • global-company-person-colleague — Query colleague list from the global company database
  • global-company-person-alumni — Query alumni list from the global company database
  • global-company-person-experience — Query work experience list from the global company database
  • global-company-person-education — Query education history list from the global company database
  • global-company-person-school-detail — Query school detail from the global company database
  • upkuajing-global-company-people-search — Global company and people search
  • upkuajing-customs-trade-company-search — Search customs trade companies
  • upkuajing-email-tool — Send emails and manage email tasks
  • upkuajing-map-merchants-search — Map-based merchant search
  • upkuajing-contact-info-validity-check — Check contact info validity
  • phone-validity-check — Check phone number validity
  • email-validity-check — Check email address validity
  • domain-validity-check — Check domain validity and security

Related skills

对接全球通信运营商发送批量跨境短信,实时查看每条短信的发送状态,助力外贸从业者开展海外营销推广、订单物流通知以及客户精细化触达。

1 installs

B2B outreach toolkit: send bulk cold email and global SMS, harvest Google Maps merchants, and validate contact info (phone/WhatsApp, email, domain) before reaching out. Monitor email/SMS delivery status, cleanse CRM contact lists, and run end-to-end cross-border outreach campaigns. Trigger: bulk cold email, email send, email open rate tracker, business domain emails, mass mail for exporters, global bulk SMS, two-way SMS replies, SMS delivery reports, cross-border SMS marketing, Google maps business scraper, merchant data download, radius-based lead search, distributor sourcing, phone number validation, WhatsApp status check, email address validation, domain validity security check, CRM data cleansing, bulk SMS pre-verification, B2B outreach campaign

2 installs

Send SMS jobs and check SMS delivery status through the Retarus SMS for Applications REST API. Use when Codex or OpenClaw needs to create SMS jobs, inspect p...

20 installs

支持发送个性化邮件,自动追踪邮件打开、点击及回复数据,助力企业高效开展跨境客户触达与海外营销推广,适用于外贸开发、客户跟进与跨境私域运营。

1 installs