{"note":"OpenAPI conversion -- returning structured metadata","name":"apideck-com-sms","description":"SMS API","version":"10.24.12","base_url":"https://unify.apideck.com","endpoints":5,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api SMS API\n@base https://unify.apideck.com\n@version 10.24.12\n@auth ApiKey Authorization in header\n@endpoints 5\n@toc sms(5)\n\n@endpoint GET /sms/messages\n@desc List Messages\n@required {x-apideck-consumer-id: str # ID of the consumer which you want to get or push data from, x-apideck-app-id: str # The ID of your Unify application}\n@optional {raw: bool=false # Include raw response. Mostly used for debugging purposes, x-apideck-service-id: str # Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API., cursor: str # Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response., limit: int=20 # Number of results to return. Minimum 1, Maximum 200, Default 20, fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: [map], _raw: map?, meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}} # Messages\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /sms/messages\n@desc Create Message\n@required {x-apideck-consumer-id: str # ID of the consumer which you want to get or push data from, x-apideck-app-id: str # The ID of your Unify application, from: str # The phone number that initiated the message., to: str # The phone number that received the message., body: str # The message text.}\n@optional {raw: bool=false # Include raw response. Mostly used for debugging purposes, x-apideck-service-id: str # Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API., id: str # A unique identifier for an object., subject: str, type: str(sms/mms) # Set to sms for SMS messages and mms for MMS messages., number_of_units: int # The number of units that make up the complete message. Messages can be split up due to the constraints of the message size., number_of_media_files: int # The number of media files associated with the message., direction: str(inbound/outbound-api/outbound-call/outbound-reply/unknown) # The direction of the message., status: str(accepted/scheduled/canceled/queued/sending/sent/failed/delivered/undelivered/receiving/received/read) # Status of the delivery of the message., scheduled_at: str(date-time) # The scheduled date and time of the message., sent_at: str(date-time) # The date and time that the message was sent, webhook_url: str # Define a webhook to receive delivery notifications., reference: str # A client reference., price: map{per_unit: str, total_amount: str, currency: str} # Price of the message., error: map{code: str, message: str} # The error returned if your message status is failed or undelivered., messaging_service_id: str # The ID of the Messaging Service used with the message. In case of Plivo this links to the Powerpack ID., custom_mappings: map # When custom mappings are configured on the resource, the result is included here., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(201) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Messages\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /sms/messages/{id}\n@desc Get Message\n@required {id: str # ID of the record you are acting upon., x-apideck-consumer-id: str # ID of the consumer which you want to get or push data from, x-apideck-app-id: str # The ID of your Unify application}\n@optional {x-apideck-service-id: str # Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API., raw: bool=false # Include raw response. Mostly used for debugging purposes, fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, from: str, to: str, subject: str, body: str, type: str, number_of_units: int, number_of_media_files: int, direction: str, status: str, scheduled_at: str(date-time), sent_at: str(date-time), webhook_url: str, reference: str, price: map{per_unit: str, total_amount: str, currency: str?}, error: map{code: str, message: str}, messaging_service_id: str, custom_mappings: map?, updated_by: str?, created_by: str?, updated_at: str(date-time)?, created_at: str(date-time)?, pass_through: [map]}, _raw: map?} # Messages\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint PATCH /sms/messages/{id}\n@desc Update Message\n@required {id: str # ID of the record you are acting upon., x-apideck-consumer-id: str # ID of the consumer which you want to get or push data from, x-apideck-app-id: str # The ID of your Unify application, from: str # The phone number that initiated the message., to: str # The phone number that received the message., body: str # The message text.}\n@optional {x-apideck-service-id: str # Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API., raw: bool=false # Include raw response. Mostly used for debugging purposes, id: str # A unique identifier for an object., subject: str, type: str(sms/mms) # Set to sms for SMS messages and mms for MMS messages., number_of_units: int # The number of units that make up the complete message. Messages can be split up due to the constraints of the message size., number_of_media_files: int # The number of media files associated with the message., direction: str(inbound/outbound-api/outbound-call/outbound-reply/unknown) # The direction of the message., status: str(accepted/scheduled/canceled/queued/sending/sent/failed/delivered/undelivered/receiving/received/read) # Status of the delivery of the message., scheduled_at: str(date-time) # The scheduled date and time of the message., sent_at: str(date-time) # The date and time that the message was sent, webhook_url: str # Define a webhook to receive delivery notifications., reference: str # A client reference., price: map{per_unit: str, total_amount: str, currency: str} # Price of the message., error: map{code: str, message: str} # The error returned if your message status is failed or undelivered., messaging_service_id: str # The ID of the Messaging Service used with the message. In case of Plivo this links to the Powerpack ID., custom_mappings: map # When custom mappings are configured on the resource, the result is included here., updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created., pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}] # The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Messages\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint DELETE /sms/messages/{id}\n@desc Delete Message\n@required {id: str # ID of the record you are acting upon., x-apideck-consumer-id: str # ID of the consumer which you want to get or push data from, x-apideck-app-id: str # The ID of your Unify application}\n@optional {x-apideck-service-id: str # Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API., raw: bool=false # Include raw response. Mostly used for debugging purposes}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?} # Messages\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@end\n"}