Merge pull request #326 from signalwire/Devon/messaging-error-codes

message-logs: add error_message and error_code to MessageLog response

Author: Devon-White

fern/apis/signalwire-rest/openapi.yaml

@@ -24690,6 +24690,8 @@ components:
         - charge
         - charge_details
         - created_at
+        - error_message
+        - error_code
       properties:
         id:
           allOf:
@@ -24784,6 +24786,20 @@ components:
           description: Date and time when the message entry was created.
           examples:
             - '2024-05-06T12:20:00Z'
+        error_message:
+          anyOf:
+            - type: string
+            - type: 'null'
+          description: Description of the error when the message failed. Null when the message did not fail. LaML messages use the codes documented at https://signalwire.com/docs/compatibility-api/rest/error-codes.
+          examples:
+            - From number is not a SMS-capable phone number.
+        error_code:
+          anyOf:
+            - type: string
+            - type: 'null'
+          description: Error code identifying why the message failed. Null when the message did not fail. Some Relay messages may have an `error_message` without an `error_code` — the `error_code` is a newer pattern that is not used in all Relay areas.
+          examples:
+            - '21601'
       unevaluatedProperties:
         not: {}
       description: Response model for message log retrieve endpoint
@@ -24929,6 +24945,8 @@ components:
         - charge
         - charge_details
         - created_at
+        - error_message
+        - error_code
       properties:
         id:
           allOf:
@@ -25023,6 +25041,20 @@ components:
           description: Date and time when the message entry was created.
           examples:
             - '2024-05-06T12:20:00Z'
+        error_message:
+          anyOf:
+            - type: string
+            - type: 'null'
+          description: Description of the error when the message failed. Null when the message did not fail. LaML messages use the codes documented at https://signalwire.com/docs/compatibility-api/rest/error-codes.
+          examples:
+            - From number is not a SMS-capable phone number.
+        error_code:
+          anyOf:
+            - type: string
+            - type: 'null'
+          description: Error code identifying why the message failed. Null when the message did not fail. Some Relay messages may have an `error_message` without an `error_code` — the `error_code` is a newer pattern that is not used in all Relay areas.
+          examples:
+            - '21601'
       unevaluatedProperties:
         not: {}
       description: Message log entry with all activity details

specs/signalwire-rest/message-api/logs/models/core.tsp

@@ -88,4 +88,12 @@ model MessageLog {
   @doc("Date and time when the message entry was created.")
   @example(UTC_TIME_EXAMPLE)
   created_at: utcDateTime;
+
+  @doc("Description of the error when the message failed. Null when the message did not fail. LaML messages use the codes documented at https://signalwire.com/docs/compatibility-api/rest/error-codes.")
+  @example("From number is not a SMS-capable phone number.")
+  error_message: string | null;
+
+  @doc("Error code identifying why the message failed. Null when the message did not fail. Some Relay messages may have an `error_message` without an `error_code` — the `error_code` is a newer pattern that is not used in all Relay areas.")
+  @example("21601")
+  error_code: string | null;
 }