freeclimb 4.5.2 → 4.6.1

data/openapi.json

@@ -473,6 +473,7 @@
         },
         "properties": {
           "command": {
+            "x-is-no-property": true,
             "type": "string",
             "description": "Name of PerCL Command (this is automatically derived from mapping configuration and should not be manually supplied in any arguments)"
           }
@@ -505,10 +506,6 @@
                 "description": "ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result.",
                 "type": "string"
               },
-              "callId": {
-                "description": "ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one.",
-                "type": "string"
-              },
               "leaveConferenceUrl": {
                 "description": "URL to be invoked when the Participant leaves the Conference. ",
                 "type": "string"
@@ -538,8 +535,7 @@
         "x-percl-command": true,
         "allOf": [
           {
-            "$ref": "#/components/schemas/PerclCommand",
-            "x-is-uri": true
+            "$ref": "#/components/schemas/PerclCommand"
           },
           {
             "type": "object",
@@ -651,7 +647,7 @@
               },
               "initialTimeoutMs": {
                 "description": "Maximum time in milliseconds that FreeClimb will wait for the Caller to press the first digit before making a determination that a `timeout` has occurred and moving on to make the request to the `actionUrl` to submit the results of the `GetDigits` command. This timeout interval begins when all nested commands have been fully executed.",
-                "type": "string"
+                "type": "integer"
               },
               "maxDigits": {
                 "description": "Maximum number of digits expected in the input. If the terminating digit is not entered and the caller has entered the maximum number of digits allowed, the `GetDigits` command terminates regardless of the value of `finishOnKey`.",
@@ -692,7 +688,8 @@
                 "description": "When the caller has finished speaking or the command has timed out, FreeClimb will make a POST request to this URL. A PerCL response is expected to continue handling the call.",
                 "type": "string",
                 "format": "uri",
-                "x-is-uri": true
+                "x-is-uri": true,
+                "x-is-url": true
               },
               "grammarType": {
                 "$ref": "#/components/schemas/GrammarType"
@@ -897,10 +894,6 @@
                 "description": "Number of times the audio file is played. Specifying '0' causes the Play action to loop until the Call is hung up.",
                 "type": "integer"
               },
-              "conferenceId": {
-                "description": "ID of the Conference the audio should be rendered to. If this is not specified, the audio is by default rendered to the caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error.",
-                "type": "string"
-              },
               "privacyMode": {
                 "description": "Parameter `privacyMode` will not log the `text` as required by PCI compliance.",
                 "type": "boolean"
@@ -1015,19 +1008,15 @@
       "RemoveFromConference": {
         "description": "The `RemoveFromConference` command removes a Participant from a Conference but does not hang up. Instead, the Call is simply unbridged and what happens next with the Call is determined by the PerCL returned in response to the `leaveConferenceUrl` attribute.",
         "x-percl-command": true,
+        "x-no-properties": true,
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
           },
           {
-            "required": ["callId"],
+            "required": [],
             "type": "object",
-            "properties": {
-              "callId": {
-                "description": "ID of the Call leg to be removed from the Conference. The Call must be in a Conference or an error will be triggered.",
-                "type": "string"
-              }
-            }
+            "properties": {}
           }
         ]
       },
@@ -1055,10 +1044,6 @@
                 "type": "integer",
                 "default": 1
               },
-              "conferenceId": {
-                "description": "D of the Conference the speech should be rendered to. If this is not specified, the speech is by default rendered to the Caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error.",
-                "type": "string"
-              },
               "privacyMode": {
                 "description": "Parameter `privacyMode` will not log the `text` as required by PCI compliance.",
                 "type": "boolean"
@@ -1102,13 +1087,9 @@
             "$ref": "#/components/schemas/PerclCommand"
           },
           {
-            "required": ["callId"],
+            "required": [],
             "type": "object",
             "properties": {
-              "callId": {
-                "description": "ID of the call leg that is to be assigned the listen privilege. The Call must be in a Conference or an error will be triggered.",
-                "type": "string"
-              },
               "listen": {
                 "description": "Specifying `false` will silence the Conference for this Participant.",
                 "type": "boolean"
@@ -1125,13 +1106,9 @@
             "$ref": "#/components/schemas/PerclCommand"
           },
           {
-            "required": ["callId"],
+            "required": [],
             "type": "object",
             "properties": {
-              "callId": {
-                "description": "ID of the call leg that is to be muted or unmuted. The Call must be in a Conference or an error will be triggered.",
-                "type": "string"
-              },
               "talk": {
                 "description": "Specifying `false` mutes the Participant.",
                 "type": "boolean"
@@ -1156,6 +1133,7 @@
                 "type": "string"
               },
               "from": {
+                "x-is-private-property": true,
                 "description": "E.164 representation of the phone number to use as the sender. This must be an incoming phone number you have purchased from FreeClimb.",
                 "type": "string"
               },
@@ -1187,19 +1165,15 @@
       "TerminateConference": {
         "description": "The `TerminateConference` command terminates an existing Conference. Any active participants are hung up on by FreeClimb. If this is not the desired behavior, use the `RemoveFromConference` command to unbridge Calls that should not be hung up. Note: The Call requesting TerminateConference must be on the same Conference for this command to execute.",
         "x-percl-command": true,
+        "x-no-properties": true,
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
           },
           {
-            "required": ["conferenceId"],
+            "required": [],
             "type": "object",
-            "properties": {
-              "conferenceId": {
-                "description": "ID of the conference to terminate.",
-                "type": "string"
-              }
-            }
+            "properties": {}
           }
         ]
       },
@@ -1310,6 +1284,18 @@
           }
         }
       },
+      "TFN": {
+        "description": "TollFree Campaign details for this number",
+        "type": "object",
+        "required": ["campaignId"],
+        "x-is-object": true,
+        "properties": {
+          "campaignId": {
+            "description": "alphanumeric identifier for the TollFree campaign associated with this number",
+            "type": "string"
+          }
+        }
+      },
       "AccountRequest": {
         "type": "object",
         "properties": {
@@ -1609,6 +1595,10 @@
                 "type": "boolean",
                 "description": "The offnet field is a boolean representing whether the number is offnet registered or not. This field will be rendered only for requests to the IncomingPhone number resource.",
                 "nullable": true
+              },
+              "tfn": {
+                "$ref": "#/components/schemas/TFN",
+                "nullable": true
               }
             }
           }
@@ -1694,6 +1684,7 @@
                 "nullable": true
               },
               "from": {
+                "x-is-private-property": true,
                 "type": "string",
                 "description": "Phone number that initiated this Call.",
                 "nullable": true
@@ -1765,6 +1756,7 @@
         "required": ["from", "to"],
         "properties": {
           "from": {
+            "x-is-private-property": true,
             "type": "string",
             "description": "Phone number to use as the caller ID. This can be: (a) The To or From number provided in FreeClimb's initial request to your app or (b) Any incoming phone number you have purchased from FreeClimb."
           },
@@ -2033,6 +2025,7 @@
             "required": ["from", "to", "text"],
             "properties": {
               "from": {
+                "x-is-private-property": true,
                 "type": "string",
                 "description": "Phone number to use as the sender. This must be an incoming phone number that you have purchased from FreeClimb."
               },
@@ -2048,9 +2041,14 @@
                 "type": "string",
                 "description": "When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters.  **Note:** This is a notification only; any PerCL returned is ignored."
               },
-              "accountId": {
-                "type": "string",
-                "description": "String that uniquely identifies this account resource."
+              "mediaUrls": {
+                "type": "array",
+                "description": "an array of HTTP URLs which are to be used as attachments to the message. This will force the message into being an MMS message and must be done using a from number which is MMS capabile.",
+                "x-is-list": true,
+                "items": {
+                  "type": "string",
+                  "format": "uri"
+                }
               }
             }
           }
@@ -2098,6 +2096,7 @@
                 "$ref": "#/components/schemas/MessageStatus"
               },
               "from": {
+                "x-is-private-property": true,
                 "type": "string",
                 "description": "Phone number in E.164 format that sent the message.",
                 "nullable": true
@@ -2136,6 +2135,15 @@
                 "type": "number",
                 "description": "The number of segments into which the message was split",
                 "nullable": true
+              },
+              "mediaUrls": {
+                "type": "array",
+                "description": "an array of HTTP URLs which were attached this this message",
+                "x-is-list": true,
+                "items": {
+                  "type": "string",
+                  "format": "uri"
+                }
               }
             }
           }
@@ -2452,6 +2460,7 @@
             "type": "string",
             "x-has-writer": true,
             "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
+            "x-enum-type": "SMSTenDLCCampaignStatusEnum",
             "enum": ["ACTIVE", "EXPIRED"],
             "x-enum-varnames": ["ACTIVE", "EXPIRED"]
           },
@@ -2579,6 +2588,31 @@
             "nullable": true,
             "description": "Help message of the campaign."
           },
+          "optinKeywords": {
+            "maxLength": 255,
+            "type": "string",
+            "description": "Subscriber opt-in keywords. Multiple keywords are comma separated without space."
+          },
+          "optoutKeywords": {
+            "maxLength": 255,
+            "type": "string",
+            "description": "Subscriber opt-out keywords. Multiple keywords are comma separated without space."
+          },
+          "helpKeywords": {
+            "maxLength": 255,
+            "type": "string",
+            "description": "Subscriber help keywords. Multiple keywords are comma separated without space."
+          },
+          "optinMessage": {
+            "maxLength": 255,
+            "type": "string",
+            "description": "Subscriber opt-in message."
+          },
+          "optoutMessage": {
+            "maxLength": 255,
+            "type": "string",
+            "description": "Subscriber opt-out message."
+          },
           "referenceId": {
             "maxLength": 50,
             "type": "string",
@@ -2669,6 +2703,7 @@
             "type": "string",
             "x-has-writer": true,
             "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
+            "x-enum-type": "SMSTenDLCPartnerCampaignStatusEnum",
             "enum": ["ACTIVE", "EXPIRED"],
             "x-enum-varnames": ["ACTIVE", "EXPIRED"]
           },
@@ -2953,6 +2988,7 @@
           "vertical"
         ],
         "type": "object",
+        "x-sms-ten-dlc-brand": true,
         "properties": {
           "accountId": {
             "type": "string",
@@ -2964,6 +3000,7 @@
             "type": "string",
             "x-has-writer": true,
             "description": "Entity type behind the brand. This is the form of business establishment.",
+            "x-enum-type": "SMSTenDLCBrandEntityTypeEnum",
             "enum": [
               "PRIVATE_PROFIT",
               "PUBLIC_PROFIT",
@@ -3077,6 +3114,7 @@
             "x-has-writer": true,
             "description": "(Required for public company) stock exchange.",
             "example": "NASDAQ",
+            "x-enum-type": "SMSTenDLCBrandStockExchangeEnum",
             "enum": [
               "NONE",
               "NASDAQ",
@@ -3151,6 +3189,7 @@
             "type": "string",
             "x-has-writer": true,
             "description": "Brand relationship to the CSP",
+            "x-enum-type": "SMSTenDLCBrandBrandRelationshipEnum",
             "enum": [
               "BASIC_ACCOUNT",
               "SMALL_ACCOUNT",
@@ -3179,6 +3218,7 @@
           "altBusinessIdType": {
             "type": "string",
             "x-has-writer": true,
+            "x-enum-type": "SMSTenDLCBrandAltBusinessIdTypeEnum",
             "enum": ["NONE", "DUNS", "GIIN", "LEI"],
             "x-enum-varnames": ["NONE", "DUNS", "GIIN", "LEI"],
             "description": "The type of the Alternative business identifier"
@@ -3211,6 +3251,7 @@
             "type": "string",
             "x-has-writer": true,
             "description": "TCR assessment of the brand identification status.",
+            "x-enum-type": "SMSTenDLCBrandIdentityStatusEnum",
             "enum": [
               "SELF_DECLARED",
               "UNVERIFIED",
@@ -3264,61 +3305,147 @@
           "createDate": "2022-07-01T20:29:23Z"
         }
       },
+      "SMSTollFreeCampaignsListResult": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/PaginationModel"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "brands": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/SMSTollFreeCampaign"
+                },
+                "nullable": true,
+                "x-is-list": true
+              }
+            }
+          }
+        ]
+      },
+      "SMSTollFreeCampaign": {
+        "type": "object",
+        "required": [
+          "accountId",
+          "campaignId",
+          "useCase",
+          "registrationStatus",
+          "dateCreated",
+          "dateUpdated",
+          "revision"
+        ],
+        "x-sms-toll-free-campaign": true,
+        "properties": {
+          "accountId": {
+            "type": "string",
+            "description": "ID of the account that created this toll-free campaign",
+            "nullable": true
+          },
+          "campaignId": {
+            "type": "string",
+            "description": "Alphanumeric identifier used by the platform to identify this toll-free campaign"
+          },
+          "useCase": {
+            "type": "string"
+          },
+          "registrationStatus": {
+            "type": "string",
+            "x-has-writer": true,
+            "description": "Current toll-free campaign registration status.Possible values: UNREGISTERED,INITIATED,PENDING,DECLINED,REGISTERED. A newly created campaign defaults to INITIATED status. ",
+            "x-enum-type": "SMSTollFreeCampaignRegistrationStatusEnum",
+            "enum": [
+              "UNREGISTERED",
+              "INITIATED",
+              "PENDING",
+              "DECLINED",
+              "REGISTERED"
+            ],
+            "x-enum-varnames": [
+              "UNREGISTERED",
+              "INITIATED",
+              "PENDING",
+              "DECLINED",
+              "REGISTERED"
+            ]
+          },
+          "dateCreated": {
+            "type": "string"
+          },
+          "dateUpdated": {
+            "type": "string"
+          },
+          "revision": {
+            "type": "integer"
+          }
+        }
+      },
       "TranscribeUtterance": {
         "title": "TranscribeUtterance",
         "x-stoplight": {
           "id": "u509r3zqc38ze"
         },
-        "x-percl-command": true,
-        "type": "object",
         "description": "The `TranscribeUtterance` command transcribes the caller’s voice and returns transcription of the audio and optionally returns the recording of the audio transcribed.\n\n`TranscribeUtterance` is blocking and is a terminal command. As such, the actionUrl property is required, and control of the Call picks up using the `PerCL` returned in response of the `actionUrl`. Recording and Transcription information is returned in the actionUrl request. If the reason this command ended was due to the call hanging up, any PerCL returned will not execute.",
-        "properties": {
-          "actionUrl": {
-            "type": "string"
-          },
-          "playBeep": {
-            "type": "boolean",
-            "default": false
+        "x-percl-command": true,
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/PerclCommand"
           },
-          "record": {
+          {
+            "required": ["actionUrl"],
             "type": "object",
+            "description": "The `TranscribeUtterance` command transcribes the caller’s voice and returns transcription of the audio and optionally returns the recording of the audio transcribed.\n\n`TranscribeUtterance` is blocking and is a terminal command. As such, the actionUrl property is required, and control of the Call picks up using the `PerCL` returned in response of the `actionUrl`. Recording and Transcription information is returned in the actionUrl request. If the reason this command ended was due to the call hanging up, any PerCL returned will not execute.",
             "properties": {
-              "saveRecording": {
+              "actionUrl": {
+                "type": "string"
+              },
+              "playBeep": {
                 "type": "boolean",
                 "default": false
               },
-              "maxLengthSec": {
-                "type": "integer",
-                "minimum": 1,
-                "maximum": 60,
-                "default": 60
+              "record": {
+                "type": "object",
+                "x-is-object": true,
+                "properties": {
+                  "saveRecording": {
+                    "type": "boolean",
+                    "default": false
+                  },
+                  "maxLengthSec": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 60,
+                    "default": 60
+                  },
+                  "rcrdTerminationSilenceTimeMs": {
+                    "type": "integer",
+                    "exclusiveMinimum": true,
+                    "minimum": 0,
+                    "maximum": 3000
+                  }
+                }
               },
-              "rcrdTerminationSilenceTimeMs": {
-                "type": "integer",
-                "exclusiveMinimum": true,
-                "minimum": 0,
-                "maximum": 3000
+              "privacyForLogging": {
+                "type": "boolean",
+                "default": false
+              },
+              "privacyForRecording": {
+                "type": "boolean",
+                "default": false
+              },
+              "prompts": {
+                "type": "array",
+                "x-is-list": true,
+                "items": {}
               }
             }
-          },
-          "privacyForLogging": {
-            "type": "boolean",
-            "default": false
-          },
-          "privacyForRecording": {
-            "type": "boolean",
-            "default": false
-          },
-          "prompts": {
-            "type": "array",
-            "items": {}
           }
-        },
-        "required": ["actionUrl"],
+        ],
         "x-examples": {
           "Example 1": {
             "TranscribeUtterance": {
-              "actionUrl": "http://foo.vail/handleTranscription",
+              "actionUrl": "http://yoursite.com/handleTranscription",
               "record": {
                 "maxLengthSec": 60,
                 "saveRecording": true,
@@ -3335,6 +3462,28 @@
             }
           }
         }
+      },
+      "CreateWebRTCToken": {
+        "type": "object",
+        "required": ["to", "from", "uses"],
+        "x-web-rtc": true,
+        "additionalProperties": false,
+        "properties": {
+          "to": {
+            "type": "string",
+            "description": "E.164 formatted phone number to which calls using this token will be made."
+          },
+          "from": {
+            "x-is-private-property": true,
+            "type": "string",
+            "description": "E.164 formatted phone number owned by the reqeusting account from which calls using this token will be made."
+          },
+          "uses": {
+            "type": "integer",
+            "description": "number of times this token may be used for a WebRTC call",
+            "minimum": 1
+          }
+        }
       }
     }
   },
@@ -3857,6 +4006,15 @@
           {
             "$ref": "#/components/parameters/Capabilities.ShortCode"
           },
+          {
+            "name": "tfn.campaignId",
+            "in": "query",
+            "required": false,
+            "description": "Only show incoming phone number resources that have been assigned to the provided TFNCampaign ID.",
+            "schema": {
+              "type": "string"
+            }
+          },
           {
             "name": "offnet",
             "in": "query",
@@ -4200,6 +4358,43 @@
         }
       }
     },
+    "/Accounts/{accountId}/Calls/WebRTC/Token": {
+      "post": {
+        "summary": "Make a JWT for WebRTC calling",
+        "description": "Make a JWT for WebRTC calling",
+        "operationId": "make-a-webrtc-jwt",
+        "x-web-rtc": true,
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountId"
+          }
+        ],
+        "requestBody": {
+          "description": "Information needed to craft a JWT compatible with the platforms WebRTC APIs",
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateWebRTCToken"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "The created JWT",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "string",
+                  "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjEyMzQ1Njc4LCJjdXN0b20iOnsidG8iOiIrMTEyMjMzMzQ0NDQiLCJmcm9tIjoiKzE0NDQ0MzMzMjIxIiwidXNlcyI6MX19.H3UKv7poe0adLoFpilxOtC5dGsE5eb2ZxiuygDPs23E"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/Accounts/{accountId}/Conferences": {
       "post": {
         "tags": [],
@@ -4325,15 +4520,8 @@
         },
         "deprecated": false,
         "responses": {
-          "200": {
-            "description": "Conference Details to Update",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ConferenceResult"
-                }
-              }
-            }
+          "204": {
+            "description": "Successful conference details update"
           }
         }
       },
@@ -4550,6 +4738,58 @@
         }
       }
     },
+    "/Accounts/{accountId}/Conferences/{conferenceId}/Recordings": {
+      "get": {
+        "tags": [],
+        "summary": "List Conference Recordings",
+        "operationId": "list-conference-recordings",
+        "parameters": [
+          {
+            "name": "callId",
+            "in": "query",
+            "description": "Show only Recordings made during the Call with this ID.",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "dateCreated",
+            "in": "query",
+            "description": "Only show Recordings created on this date, formatted as *YYYY-MM-DD*.",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/AccountId"
+          },
+          {
+            "name": "conferenceId",
+            "in": "path",
+            "description": "Show only Recordings made during the conference with this ID.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "List of Recordings",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RecordingList"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
     "/Accounts/{accountId}/Queues/{queueId}": {
       "post": {
         "tags": [],
@@ -5615,6 +5855,85 @@
         },
         "deprecated": false
       }
+    },
+    "/Accounts/{accountId}/Messages/TollFree/Campaigns": {
+      "get": {
+        "tags": [],
+        "summary": "Get list of TollFree Campaigns",
+        "operationId": "get-tollFree-sms-campaigns",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountId"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The list toll-free campaigns",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SMSTollFreeCampaignsListResult"
+                },
+                "example": {
+                  "total": 1,
+                  "start": 0,
+                  "end": 0,
+                  "page": 0,
+                  "numPages": 1,
+                  "pageSize": 100,
+                  "nextPageUri": null,
+                  "tfnCampaigns": [
+                    {
+                      "accountId": "ACe39970fb7c31c747c67148900b4d9da60a41e532",
+                      "campaignId": "cmptfn_387ec3f6e03b340553f35f29c8f118cdf3eae08a",
+                      "useCase": "example use case",
+                      "registrationStatus": "PENDING",
+                      "dateCreated": 1704839615,
+                      "dateUpdated": 1704839615,
+                      "revision": 1
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/Accounts/{accountId}/Messages/TollFree/Campaigns/{campaignId}": {
+      "get": {
+        "tags": [],
+        "summary": "Get a TollFree SMS Campaign",
+        "operationId": "get-tollFree-sms-campaign",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountId"
+          },
+          {
+            "name": "campaignId",
+            "in": "path",
+            "description": "String that uniquely identifies this TollFree Campaign resource.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The specific SMS TollFree Campaign that’s been processed by FreeClimb",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SMSTollFreeCampaign"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
     }
   },
   "x-headers": [],