package spec.proto.extension.v1.sms

Get desktop application:
View/edit binary Protocol Buffers messages

SmsService is used to send SMS messages.

• rpc SendSmsWithTemplate (SendSmsWithTemplateRequest, SendSmsWithTemplateResponse)

  sms.proto:12

  Send the SMS message.

  message SendSmsWithTemplateRequest

  sms.proto:17

  SendSmsRequest is the request of the `SendSms` method.

  • string component_name = 1

    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.

  • repeated string phone_numbers = 2

    Required. The SMS receive phone numbers.

  • optional Template template = 3

    Required.

  • string sign_name = 4

    The registered sign name

  • string sender_id = 5

    The SMS sender tag.

  • map<string, string> metadata = 6

    The metadata which will be sent to SMS components.

  message SendSmsWithTemplateResponse

  sms.proto:53

  SendSmsResponse is the response of the `SendSms` method.

  • string request_id = 1

    The unique requestId.

  • repeated SendStatus results = 2

    The status set of SMS

Status contains more information about the response

Used in: SendSmsWithTemplateResponse

• string code = 1

  "OK" represents success.

• string message = 2

  The error message.

• map<string, string> metadata = 3

  The send status metadata returned from SMS service. Includes `PhoneNumber`. `PhoneNumber`, is the phone number SMS send to. Supported by tencentcloud.

Sms template

Used in: SendSmsWithTemplateRequest

• string template_id = 1

  Required

• map<string, string> template_params = 2

  Required