feat: modify sms api proto (#982)

mosn · Aug 18, 2023 · 1694e7a · 1694e7a
1 parent 6498f86
commit 1694e7a
Show file tree

Hide file tree

Showing 3 changed files with 158 additions and 46 deletions.
diff --git a/docs/api/v1/sms.html b/docs/api/v1/sms.html
@@ -192,7 +192,11 @@ <h2>Table of Contents</h2>
                 </li>
               
                 <li>
-                  <a href="#spec.proto.extension.v1.sms.SendSmsWithTemplateResponse.MetadataEntry"><span class="badge">M</span>SendSmsWithTemplateResponse.MetadataEntry</a>
+                  <a href="#spec.proto.extension.v1.sms.SendStatus"><span class="badge">M</span>SendStatus</a>
+                </li>
+              
+                <li>
+                  <a href="#spec.proto.extension.v1.sms.SendStatus.MetadataEntry"><span class="badge">M</span>SendStatus.MetadataEntry</a>
                 </li>
               
                 <li>
@@ -340,7 +344,7 @@ <h3 id="spec.proto.extension.v1.sms.SendSmsWithTemplateRequest.MetadataEntry">Se
 
 
         <h3 id="spec.proto.extension.v1.sms.SendSmsWithTemplateResponse">SendSmsWithTemplateResponse</h3>
-        <p>SendSmsResponse is the reponse of the `SendSms` method.</p>
+        <p>SendSmsResponse is the response of the `SendSms` method.</p>
 
 
           <table class="field-table">
@@ -356,6 +360,30 @@ <h3 id="spec.proto.extension.v1.sms.SendSmsWithTemplateResponse">SendSmsWithTemp
                   <td><p>The unique requestId. </p></td>
                 </tr>
 
+                <tr>
+                  <td>results</td>
+                  <td><a href="#spec.proto.extension.v1.sms.SendStatus">SendStatus</a></td>
+                  <td>repeated</td>
+                  <td><p>The status set of SMS </p></td>
+                </tr>
+
+            </tbody>
+          </table>
+
+
+
+
+
+        <h3 id="spec.proto.extension.v1.sms.SendStatus">SendStatus</h3>
+        <p>Status contains more information about the response</p>
+
+
+          <table class="field-table">
+            <thead>
+              <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+            </thead>
+            <tbody>
+
                 <tr>
                   <td>code</td>
                   <td><a href="#string">string</a></td>
@@ -372,9 +400,11 @@ <h3 id="spec.proto.extension.v1.sms.SendSmsWithTemplateResponse">SendSmsWithTemp
 
                 <tr>
                   <td>metadata</td>
-                  <td><a href="#spec.proto.extension.v1.sms.SendSmsWithTemplateResponse.MetadataEntry">SendSmsWithTemplateResponse.MetadataEntry</a></td>
+                  <td><a href="#spec.proto.extension.v1.sms.SendStatus.MetadataEntry">SendStatus.MetadataEntry</a></td>
                   <td>repeated</td>
-                  <td><p>The metadata returned from SMS service. </p></td>
+                  <td><p>The send status metadata returned from SMS service.
+Includes `PhoneNumber`.
+`PhoneNumber`, is the phone number SMS send to. Supported by tencentcloud. </p></td>
                 </tr>
 
             </tbody>
@@ -384,7 +414,7 @@ <h3 id="spec.proto.extension.v1.sms.SendSmsWithTemplateResponse">SendSmsWithTemp
 
 
 
-        <h3 id="spec.proto.extension.v1.sms.SendSmsWithTemplateResponse.MetadataEntry">SendSmsWithTemplateResponse.MetadataEntry</h3>
+        <h3 id="spec.proto.extension.v1.sms.SendStatus.MetadataEntry">SendStatus.MetadataEntry</h3>
         <p></p>
 
 

diff --git a/spec/proto/extension/v1/sms/sms.pb.go b/spec/proto/extension/v1/sms/sms.pb.go
diff --git a/spec/proto/extension/v1/sms/sms.proto b/spec/proto/extension/v1/sms/sms.proto
@@ -35,6 +35,7 @@ message SendSmsWithTemplateRequest {
 
   // The metadata which will be sent to SMS components.
   map<string, string> metadata = 6;
+
 }
 
 // Sms template
@@ -48,17 +49,29 @@ message Template{
 
 }
 
-// SendSmsResponse is the reponse of the `SendSms` method.
+// SendSmsResponse is the response of the `SendSms` method.
 message SendSmsWithTemplateResponse {
+
   // The unique requestId.
   string request_id = 1;
 
+  // The status set of SMS
+  repeated SendStatus results = 2;
+
+}
+
+// Status contains more information about the response
+message SendStatus {
+
   // "OK" represents success.
-  string code = 2;
+  string code = 1;
 
   // The error message.
-  string message = 3;
+  string message = 2;
+
+  // The send status metadata returned from SMS service.
+  // Includes `PhoneNumber`.
+  // `PhoneNumber`, is the phone number SMS send to. Supported by tencentcloud.
+  map<string, string> metadata = 3;
 
-  // The metadata returned from SMS service.
-  map<string, string> metadata = 4;
 }