Protocol Documentation

Table of Contents

sms.proto

Top

[gRPC Service] SmsService

SmsService is used to send SMS messages.

Method NameRequest TypeResponse TypeDescription
SendSmsWithTemplate SendSmsWithTemplateRequest SendSmsWithTemplateResponse

Send the SMS message.

SendSmsWithTemplateRequest

SendSmsRequest is the request of the `SendSms` method.

FieldTypeLabelDescription
component_name string

Required. The saas service name If your system uses multiple SMS services at the same time, you can specify which service to use with this field.

phone_numbers string repeated

Required. The SMS receive phone numbers.

template Template

Required.

sign_name string

The registered sign name

sender_id string

The SMS sender tag.

metadata SendSmsWithTemplateRequest.MetadataEntry repeated

The metadata which will be sent to SMS components.

SendSmsWithTemplateRequest.MetadataEntry

FieldTypeLabelDescription
key string

value string

SendSmsWithTemplateResponse

SendSmsResponse is the reponse of the `SendSms` method.

FieldTypeLabelDescription
request_id string

The unique requestId.

code string

"OK" represents success.

message string

The error message.

metadata SendSmsWithTemplateResponse.MetadataEntry repeated

The metadata returned from SMS service.

SendSmsWithTemplateResponse.MetadataEntry

FieldTypeLabelDescription
key string

value string

Template

Sms template

FieldTypeLabelDescription
template_id string

Required

template_params Template.TemplateParamsEntry repeated

Required

Template.TemplateParamsEntry

FieldTypeLabelDescription
key string

value string

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)