# Create a Message

POST https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Messages
Content-Type: application/x-www-form-urlencoded

Create and send a message.

#### Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Messaging_.

[Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Reference: https://signalwire.com/docs/compatibility-api/rest/messages/create-message

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: compatibility
  version: 1.0.0
paths:
  /Accounts/{AccountSid}/Messages:
    post:
      operationId: create-message
      summary: Create a Message
      description: >-
        Create and send a message.


        #### Permissions


        The API token used to authenticate must have the following scope(s)
        enabled to make a successful request: _Messaging_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_messages
      parameters:
        - name: AccountSid
          in: path
          description: >-
            The unique identifier of the project that sent or received this
            message.
          required: true
          schema:
            type: string
            format: uuid
        - name: Authorization
          in: header
          description: >-
            SignalWire Basic Authentication using Project ID and API Token.


            The client sends HTTP requests with the Authorization header
            containing

            the word Basic followed by a space and a base64-encoded string of
            project_id:token.

            The project ID will be used as the username and the API token as the
            password.


            Example:

            ```

            Authorization: Basic base64(project_id:token)

            ```
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Response returned when a message is created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
        '400':
          description: >-
            The request was invalid or cannot be processed. Check the error
            details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '422':
          description: >-
            The request could not be processed due to validation errors. Check
            the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMessageRequest'
servers:
  - url: https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01
components:
  schemas:
    CreateMessageRequestMediaUrl:
      oneOf:
        - type: string
        - type: array
          items:
            type: string
      description: >-
        URL(s) of media you wish to attach and send with the message. Can be
        specified multiple times for up to 8 media items.
      title: CreateMessageRequestMediaUrl
    CreateMessageRequest:
      type: object
      properties:
        To:
          type: string
          description: The phone number in E.164 format that will receive the message.
        From:
          type: string
          description: >-
            The phone number in E.164 format that will send the message. Either
            `From` or `MessagingServiceSid` must be provided.
        Body:
          type: string
          description: >-
            The text of the message. Either `Body` or `MediaUrl` must be
            provided.
        MediaUrl:
          $ref: '#/components/schemas/CreateMessageRequestMediaUrl'
          description: >-
            URL(s) of media you wish to attach and send with the message. Can be
            specified multiple times for up to 8 media items.
        SendAsMms:
          type: boolean
          description: When set to true, forces the message to be sent as an MMS.
        ApplicationSid:
          type: string
          format: uuid
          description: >-
            The SID of a SignalWire cXML Application used to configure the
            message's status callback.
        MaxPrice:
          type: string
          description: >-
            The maximum price in USD acceptable for the message to be sent.
            Format: decimal with up to 4 decimal places.
        StatusCallback:
          type: string
          format: uri
          description: >-
            A URL endpoint to receive callbacks each time the status of the
            message changes. See the [SMS status
            callback](/docs/compatibility-api/rest/messages/webhooks/sms-status-callback)
            webhook for the payload your URL will receive.
        ValidityPeriod:
          type: integer
          default: 14400
          description: >-
            The number of seconds a message will allow being queued before
            canceling. Must be between 1 and 172800 (48 hours). Default is 14400
            (4 hours).
        MessagingServiceSid:
          type: string
          format: uuid
          description: >-
            The ID of a number group to use when sending the message. Either
            `From` or `MessagingServiceSid` must be provided.
      required:
        - To
      description: Request body for creating a message.
      title: CreateMessageRequest
    MessageDirection:
      type: string
      enum:
        - inbound
        - outbound-api
        - outbound-call
        - outbound-reply
      description: Message direction.
      title: MessageDirection
    MessageStatus:
      type: string
      enum:
        - queued
        - initiated
        - sent
        - failed
        - delivered
        - undelivered
        - received
      description: Message status.
      title: MessageStatus
    MessageSubresourceUris:
      type: object
      properties:
        media:
          type: string
          description: The URI for media.
      required:
        - media
      description: Message subresource URIs.
      title: MessageSubresourceUris
    Message:
      type: object
      properties:
        account_sid:
          type: string
          format: uuid
          description: >-
            The unique identifier of the project that sent or received this
            message.
        api_version:
          type: string
          description: >-
            The version number of the SignalWire cXML REST API used to handle
            this message.
        body:
          type:
            - string
            - 'null'
          description: >-
            The text of the message. Up to 1600 characters long. May be null if
            filtered for spam.
        num_segments:
          type: integer
          description: The number of segments that make up the entire message.
        num_media:
          type: integer
          description: The number of media files that were included with the message.
        date_created:
          type: string
          description: The date and time the message was created in RFC 2822 format.
        date_sent:
          type:
            - string
            - 'null'
          description: >-
            The date and time the message was sent in RFC 2822 format, or null
            if not yet sent.
        date_updated:
          type: string
          description: The date and time the message was last updated in RFC 2822 format.
        direction:
          $ref: '#/components/schemas/MessageDirection'
          description: The direction of the message.
        error_code:
          type:
            - string
            - 'null'
          description: >-
            If an error has occurred on the message, the error code will give
            you a specific code, or null if no error.
        error_message:
          type:
            - string
            - 'null'
          description: >-
            A human readable description of the error that occurred, or null if
            no error.
        from:
          type: string
          description: The phone number in E.164 format that sent the message.
        price:
          type:
            - number
            - 'null'
          format: double
          description: >-
            The cost of the individual message billed to your project, or null
            if not yet calculated.
        price_unit:
          type: string
          description: The currency in which `price` is charged as.
        sid:
          type: string
          format: uuid
          description: A unique ID that identifies this specific message.
        status:
          $ref: '#/components/schemas/MessageStatus'
          description: Current status of the message.
        to:
          type: string
          description: The phone number in E.164 format that received the message.
        messaging_service_sid:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            If a number group was used when sending an outbound message, the
            number group's ID will be present, or null otherwise.
        uri:
          type: string
          description: The URI of this particular message.
        subresource_uris:
          $ref: '#/components/schemas/MessageSubresourceUris'
          description: The URIs for any subresources associated with this message.
      required:
        - account_sid
        - api_version
        - body
        - num_segments
        - num_media
        - date_created
        - date_sent
        - date_updated
        - direction
        - error_code
        - error_message
        - from
        - price
        - price_unit
        - sid
        - status
        - to
        - messaging_service_sid
        - uri
        - subresource_uris
      description: Message model.
      title: Message
    CompatibilityErrorResponse:
      type: object
      properties:
        code:
          type: integer
          description: Error code.
        message:
          type: string
          description: Error message.
        more_info:
          type: string
          description: URL for more information about the error.
        status:
          type: integer
          description: HTTP status code.
      required:
        - code
        - message
        - more_info
        - status
      description: Error response model.
      title: CompatibilityErrorResponse
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        SignalWire Basic Authentication using Project ID and API Token.


        The client sends HTTP requests with the Authorization header containing

        the word Basic followed by a space and a base64-encoded string of
        project_id:token.

        The project ID will be used as the username and the API token as the
        password.


        Example:

        ```

        Authorization: Basic base64(project_id:token)

        ```

```

## SDK Code Examples

```python
import requests

url = "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Messages"

payload = ""
headers = {
    "Authorization": "Basic <project_id>:<api_token>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Messages';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <project_id>:<api_token>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams('')
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Messages"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Basic <project_id>:<api_token>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <project_id>:<api_token>'
request["Content-Type"] = 'application/x-www-form-urlencoded'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Messages")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Messages', [
  'form_params' => null,
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
    'Content-Type' => 'application/x-www-form-urlencoded',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Messages");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Basic <project_id>:<api_token>",
  "Content-Type": "application/x-www-form-urlencoded"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Messages")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```