> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# List message logs

GET https://%7BYour_Space_Name%7D.signalwire.com/api/messaging/logs

Lists historical messaging activity in the project for delivery review, auditing, and troubleshooting. This collection is read-only; send or redact messages through the [Messages API](/docs/apis/rest/messages/create-message) instead.

#### 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/apis/rest/message-logs/list-message-logs

## Authentication

- `Authorization` header (basic auth, required) — 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) ```

## Request

### Query parameters

- `include_deleted` (boolean, optional, default: false) — Include logs for deleted activity.
- `created_before` (string, optional) — Return logs for activity prior to this date.
- `created_on` (string, optional) — Return logs for activity on this date.
- `created_after` (string, optional) — Return logs for activity after this date.
- `page_size` (integer, optional, default: 50) — Specify the number of results to return on a single page. The default page size is `50` and the maximum is `1000`.
- `page_number` (integer, optional, default: 0) — Page number to retrieve. Requires `page_token` when greater than `0`.
- `page_token` (string, optional) — Token for cursor-based pagination. Required when `page_number` is greater than `0`. The token is returned in pagination links.

## Response

### 200

The request has succeeded.

- `links` (Message.LogPaginationResponse, required) — Object containing pagination links
- `data` (list of Message.MessageLog, required) — Array of message log entries

## Errors

### 400 Bad Request Error

The request is invalid.

- `error` (enum, required)
  - Allowed values: `Bad Request`

### 401 Unauthorized Error

Access is unauthorized.

- `error` (enum, required)
  - Allowed values: `Unauthorized`

### 422 Unprocessable Entity Error

The request contains invalid parameters. See errors for details.

- `errors` (list of Types.StatusCodes.RestApiErrorItem, required) — List of validation errors.

### 500 Internal Server Error

An internal server error occurred.

- `error` (enum, required)
  - Allowed values: `Internal Server Error`

## Types

### Message.LogPaginationResponse

- `self` (string, required) — URL to current page
- `first` (string, required) — URL to first page
- `next` (string, optional) — URL to next page (if available)
- `prev` (string, optional) — URL to previous page (if available)

### Message.MessageLog

Message log entry with all activity details

- `id` (string, required) — A unique identifier for the log.
- `from` (string, required) — The origin phone number.
- `to` (string, required) — The destination phone number.
- `status` (enum, required) — The status of the message.
  - Allowed values: `queued`, `initiated`, `delivered`, `sent`, `received`, `undelivered`, `failed`
- `direction` (enum, required) — The direction of the message.
  - Allowed values: `inbound`, `outbound`, `outbound-api`, `outbound-call`, `outbound-reply`
- `kind` (enum, required) — The kind of message.
  - Allowed values: `sms`, `mms`
- `source` (enum, required) — Source of this log entry.
  - Allowed values: `realtime_api`, `laml`
- `type` (enum, required) — Type of this log entry.
  - Allowed values: `relay_message`, `laml_message`
- `url` (string, required, nullable) — URL for the resource associated with this log entry. Null for Relay messages.
- `number_of_segments` (integer, required) — The number of segments.
- `charge` (double, required) — The charge in dollars.
- `charge_details` (list of Message.ChargeDetail, required) — Details on charges associated with this log.
- `created_at` (datetime, required) — Date and time when the message entry was created.
- `error_message` (string, required, nullable) — 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.
- `error_code` (string, required, nullable) — 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.

### Types.StatusCodes.RestApiErrorItem

Details about a specific error.

- `type` (string, required) — The category of error.
- `code` (string, required) — A specific error code.
- `message` (string, required) — A description of what caused the error.
- `url` (string, required) — A link to documentation about this error.
- `attribute` (string, optional, nullable) — The request parameter that caused the error, if applicable.

### Message.ChargeDetail

Details on charges associated with this log.

- `description` (string, required) — Description for this charge.
- `charge` (double, required) — Charged amount.

## Examples

**Response**

```json
{
  "links": {
    "self": "https://example.signalwire.com/api/messaging/logs?page_number=0&page_size=50",
    "first": "https://example.signalwire.com/api/messaging/logs?page_size=50",
    "next": "https://example.signalwire.com/api/messaging/logs?page_number=1&page_size=50&page_token=PA6ad4c839-9329-43fe-83c6-fbe7c38583ff",
    "prev": "https://example.signalwire.com/api/messaging/logs?page_number=0&page_size=50&page_token=PA6ad4c839-9329-43fe-83c6-fbe7c38583ff"
  },
  "data": [
    {
      "id": "string",
      "from": "+12077447397",
      "to": "+12029921413",
      "status": "failed",
      "direction": "inbound",
      "kind": "sms",
      "source": "laml",
      "type": "relay_message",
      "url": "https://example.signalwire.com/api/laml/2010-04-01/Accounts/c38dacad-2f6c-4de1-93d6-cc732e0c70c5/Messages/9ee38635-899a-490a-bfd1-9e72f5eea53c",
      "number_of_segments": 1,
      "charge": 0,
      "charge_details": [
        {
          "description": "Inbound SMS",
          "charge": 0.00415
        }
      ],
      "created_at": "2024-05-06T12:20:00Z",
      "error_message": "From number is not a SMS-capable phone number.",
      "error_code": "21601"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://{your_space_name}.signalwire.com/api/messaging/logs"

response = requests.get(url, auth=("<project_id>", "<api_token>"))

print(response.json())
```

```javascript
const url = 'https://{your_space_name}.signalwire.com/api/messaging/logs';
const credentials = btoa("<project_id>:<api_token>");

const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}};

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_name}.signalwire.com/api/messaging/logs"

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

	req.SetBasicAuth("<project_id>", "<api_token>")

	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_name}.signalwire.com/api/messaging/logs")

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

request = Net::HTTP::Get.new(url)
request.basic_auth("<project_id>", "<api_token>")

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.get("https://{your_space_name}.signalwire.com/api/messaging/logs")
  .basicAuth("<project_id>", "<api_token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://{your_space_name}.signalwire.com/api/messaging/logs', [
  'headers' => [
  ],
    'auth' => ['<project_id>', '<api_token>'],
]);

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

```csharp
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://{your_space_name}.signalwire.com/api/messaging/logs");
client.Authenticator = new HttpBasicAuthenticator("<project_id>", "<api_token>");
var request = new RestRequest(Method.GET);

IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<project_id>:<api_token>".utf8).base64EncodedString()

let headers = ["Authorization": "Basic \(credentials)"]

let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/messaging/logs")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
```