{ "opencollection": "1.0.0", "info": { "name": "RingCentral Adaptive Cards SMS Templates API", "version": "1.0.58-20240529-47eda8bd" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.ringcentral.com/restapi/oauth/authorize", "accessTokenUrl": "https://platform.ringcentral.com/restapi/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "SMS Templates", "type": "folder" }, "items": [ { "info": { "name": "List Company Message Templates", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/message-store-templates", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "siteIds", "value": "", "type": "query", "description": "Site ID(s) to filter company message templates, associated with particular sites\nBy default the value is all - templates with all sites will be returned\n" } ] }, "docs": "Returns a list of company text message templates." }, { "info": { "name": "Create Company Message Template", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/message-store-templates", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new text message template on a company level. Maximum number of company templates is 50." }, { "info": { "name": "Get Company Message Template", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/message-store-templates/:templateId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "templateId", "value": "", "type": "path", "description": "Internal identifier of a text message template" } ] }, "docs": "Returns a company text message template by ID." }, { "info": { "name": "Update Company Message Template", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/message-store-templates/:templateId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "templateId", "value": "", "type": "path", "description": "Internal identifier of a text message template" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a company text message template." }, { "info": { "name": "Delete Company Message Template", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/message-store-templates/:templateId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "templateId", "value": "", "type": "path", "description": "Internal identifier of a text message template" } ] }, "docs": "Deletes a company text message template." }, { "info": { "name": "List User Message Templates", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store-templates", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "siteIds", "value": "", "type": "query", "description": "Site ID(s) to filter user message templates, associated with particular sites.\nBy default the value is all - templates with all sites will be returned\n" }, { "name": "scope", "value": "", "type": "query", "description": "Message templates scope. By default the value is all - both Personal and Company templates will be returned" } ] }, "docs": "Returns a list of user's personal text message templates." }, { "info": { "name": "Create User Message Template", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store-templates", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a user personal text message template. \nMaximum number of personal templates is 25 per user. \nMax length of the `body` property is 1000 symbols (2-byte UTF-16 encoded).\n" }, { "info": { "name": "Get User Message Template", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store-templates/:templateId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "templateId", "value": "", "type": "path", "description": "Internal identifier of a text message template" } ] }, "docs": "Returns a user personal text message template by ID." }, { "info": { "name": "Update User Message Template", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store-templates/:templateId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "templateId", "value": "", "type": "path", "description": "Internal identifier of a text message template" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a user personal text message template." }, { "info": { "name": "Delete User Message Template", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store-templates/:templateId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "templateId", "value": "", "type": "path", "description": "Internal identifier of a text message template" } ] }, "docs": "Deletes a user personal text message template." } ] } ], "bundled": true }