# Surge

## Docs

- [Archive account](https://docs.surge.app/api-reference/endpoint/accounts/archive.md): Archives an account and releases all associated resources.
- [Check account status](https://docs.surge.app/api-reference/endpoint/accounts/check-status.md): Check an account's status and capabilities
- [Create account](https://docs.surge.app/api-reference/endpoint/accounts/create.md): Creates a new Account within the calling Platform.
- [Update account](https://docs.surge.app/api-reference/endpoint/accounts/update.md): Updates an Account
- [Get file](https://docs.surge.app/api-reference/endpoint/attachments/get_file.md): Redirects to a signed URL where the attachment file can be downloaded. URL is short-lived, so redirect should be followed immediately.
- [Add contact](https://docs.surge.app/api-reference/endpoint/audiences/add_contact.md): Adds an existing contact to a manual audience.
- [Create audience](https://docs.surge.app/api-reference/endpoint/audiences/create.md): Creates a new audience.
- [List contacts](https://docs.surge.app/api-reference/endpoint/audiences/list_contacts.md): List all contacts in an audience with cursor-based pagination. The account is inferred from the audience.
- [Send blast](https://docs.surge.app/api-reference/endpoint/blasts/create.md): Sends a Blast.
- [Create campaign](https://docs.surge.app/api-reference/endpoint/campaigns/create.md): Creates a campaign to register account to send text messages.
- [Get campaign](https://docs.surge.app/api-reference/endpoint/campaigns/get.md): Retrieves a Campaign object.
- [List campaigns](https://docs.surge.app/api-reference/endpoint/campaigns/list.md): List all campaigns for an account with cursor-based pagination.
- [Update campaign](https://docs.surge.app/api-reference/endpoint/campaigns/update.md): Updates a campaign that has not yet been approved. This can be used to fix issues flagged during review and resubmit the campaign. Returns an error if the campaign is currently in review, has already been approved, or has been deactivated.
- [Create contact](https://docs.surge.app/api-reference/endpoint/contacts/create.md): Creates a new Contact object.
- [Retrieve contact](https://docs.surge.app/api-reference/endpoint/contacts/get.md): Retrieves a Contact object.
- [List contacts](https://docs.surge.app/api-reference/endpoint/contacts/list.md): List all contacts for an account with cursor-based pagination.
- [Update contact](https://docs.surge.app/api-reference/endpoint/contacts/update.md): Updates the specified contact by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
- [Create message](https://docs.surge.app/api-reference/endpoint/messages/create.md): Creates and enqueues a new message to be sent.
- [Retrieve message](https://docs.surge.app/api-reference/endpoint/messages/get.md): Retrieves a Message object.
- [List messages](https://docs.surge.app/api-reference/endpoint/messages/list.md): List all messages for an account with cursor-based pagination.
- [List phone numbers](https://docs.surge.app/api-reference/endpoint/phone-numbers/list.md): List all phone numbers for an account with cursor-based pagination.
- [Purchase phone number](https://docs.surge.app/api-reference/endpoint/phone-numbers/purchase.md): Purchase a new phone number for the account. You can specify search criteria or let the system select a random number.
- [Delete recording](https://docs.surge.app/api-reference/endpoint/recordings/delete.md): Deletes a recording. The recording file will be removed from storage asynchronously.
- [Get recording](https://docs.surge.app/api-reference/endpoint/recordings/get.md): Retrieves a Recording object.
- [Get file](https://docs.surge.app/api-reference/endpoint/recordings/get_file.md): Redirects to a signed URL where the recording audio file can be downloaded. URL is short-lived, so redirect should be followed immediately.
- [List recordings](https://docs.surge.app/api-reference/endpoint/recordings/list.md): List all recordings for an account with cursor-based pagination.
- [Create user](https://docs.surge.app/api-reference/endpoint/users/create.md): Creates a new User object.
- [Create user token](https://docs.surge.app/api-reference/endpoint/users/create-token.md): Provides a mechanism for having Surge create a signed token for embeds instead of signing with your own signing key.
- [Delete user](https://docs.surge.app/api-reference/endpoint/users/delete.md): Deletes a user.
- [Retrieve user](https://docs.surge.app/api-reference/endpoint/users/get.md): Retrieves a User object.
- [List users](https://docs.surge.app/api-reference/endpoint/users/list.md): List all users for an account with cursor-based pagination.
- [Update user](https://docs.surge.app/api-reference/endpoint/users/update.md): Updates an existing User object.
- [Check verification](https://docs.surge.app/api-reference/endpoint/verifications/check.md): Checks the code against a verification.
- [Send verification](https://docs.surge.app/api-reference/endpoint/verifications/create.md): Creates a new Verification and sends the code to the given phone number.
- [Introduction](https://docs.surge.app/api-reference/introduction.md)
- [Call Ended](https://docs.surge.app/api-reference/webhooks/call/ended.md): The `call.ended` event is delivered whenever a call is completed between a Surge number you own and another phone number.
- [Campaign Approved](https://docs.surge.app/api-reference/webhooks/campaign/approved.md): The `campaign.approved` event is delivered whenever a campaign is approved by all of the US carriers and able to start sending text messages.
- [Contact Opted In](https://docs.surge.app/api-reference/webhooks/contact/opted_in.md): The `contact.opted_in` event is delivered whenever a contact opts back in to receiving messages by sending a keyword message (START, YES, UNSTOP).
- [Contact Opted Out](https://docs.surge.app/api-reference/webhooks/contact/opted_out.md): The `contact.opted_out` event is delivered whenever a contact opts out of receiving messages by sending a keyword message (STOP, CANCEL, UNSUBSCRIBE, etc.).
- [Conversation Created](https://docs.surge.app/api-reference/webhooks/conversation/created.md): The `conversation.created` event is delivered whenever a new conversation is started with a contact. This could be when either the contact sends a message to your Surge number or when you create a conversation, whether by sending an initial message to the contact or by manually creating the conversa…
- [Introduction](https://docs.surge.app/api-reference/webhooks/intro.md)
- [Link Followed](https://docs.surge.app/api-reference/webhooks/link/followed.md): The `link.followed` event is delivered when a contact first follows a shortened link that was included in a message sent from a Surge number. This event is only triggered on the first click of each link; subsequent clicks on the same link do not generate additional events.
- [Message Delivered](https://docs.surge.app/api-reference/webhooks/message/delivered.md): The `message.delivered` event is delivered whenever a message sent from a Surge number is successfully delivered to the recipient. When the message is sent from a short code or toll-free number, this means that the message arrived on the recipient's device. When sent from a local number, this means…
- [Message Failed](https://docs.surge.app/api-reference/webhooks/message/failed.md): The `message.failed` event is delivered whenever a message sent from your Surge number fails to be delivered.
- [Message Received](https://docs.surge.app/api-reference/webhooks/message/received.md): The `message.received` event is delivered whenever a message is received at a Surge number from a contact.
- [Message Sent](https://docs.surge.app/api-reference/webhooks/message/sent.md): The `message.sent` event is delivered whenever a message is sent from a Surge number to a contact.
- [Phone Number Attached to Campaign](https://docs.surge.app/api-reference/webhooks/phone_number/attached_to_campaign.md): The `phone_number.attached_to_campaign` event is delivered whenever a phone number is attached to a campaign.
- [Recording Completed](https://docs.surge.app/api-reference/webhooks/recording/completed.md): The `recording.completed` event is delivered whenever a call recording has been processed and is ready for playback. This event is not triggered for voicemail recordings.
- [Webhook Signature Validation](https://docs.surge.app/api-reference/webhooks/signature-validation.md)
- [Voicemail Received](https://docs.surge.app/api-reference/webhooks/voicemail/received.md): The `voicemail.received` event is delivered whenever a voicemail recording has been processed and is ready for playback.
- [Register a campaign](https://docs.surge.app/guides/carrier-registration/register-a-campaign.md)
- [Authentication](https://docs.surge.app/ui/authentication.md)
- [Conversation](https://docs.surge.app/ui/components/conversation.md): The conversation component displays the messages and attachments in a single conversation and a composer that allows the user to send new messages in that conversation.
- [Inbox](https://docs.surge.app/ui/components/inbox.md): The inbox component provides a full messenger interface in a single component.
- [Unread Count](https://docs.surge.app/ui/components/unread-count.md): The unread count component displays a count of all the unread messages for a given user.
- [Introduction](https://docs.surge.app/ui/introduction.md): Introduction to the UI components provided by Surge

## OpenAPI Specs

- [openapi.documented](https://app.stainless.com/api/spec/documented/surge/openapi.documented.yml)