Skip to content

Latest commit

 

History

History
188 lines (104 loc) · 6.48 KB

UsersConversationsApi.md

File metadata and controls

188 lines (104 loc) · 6.48 KB

UsersConversationsApi

All URIs are relative to https://conversations.twilio.com

Method HTTP request Description
DeleteUserConversation Delete /v1/Users/{UserSid}/Conversations/{ConversationSid}
FetchUserConversation Get /v1/Users/{UserSid}/Conversations/{ConversationSid}
ListUserConversation Get /v1/Users/{UserSid}/Conversations
UpdateUserConversation Post /v1/Users/{UserSid}/Conversations/{ConversationSid}

DeleteUserConversation

DeleteUserConversation(ctx, UserSidConversationSid)

Delete a specific User Conversation.

Path Parameters

Name Type Description
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
UserSid string The unique SID identifier of the User resource. This value can be either the sid or the identity of the User resource.
ConversationSid string The unique SID identifier of the Conversation. This value can be either the sid or the unique_name of the Conversation resource.

Other Parameters

Other parameters are passed through a pointer to a DeleteUserConversationParams struct

Name Type Description

Return type

(empty response body)

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FetchUserConversation

ConversationsV1UserConversation FetchUserConversation(ctx, UserSidConversationSid)

Fetch a specific User Conversation.

Path Parameters

Name Type Description
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
UserSid string The unique SID identifier of the User resource. This value can be either the sid or the identity of the User resource.
ConversationSid string The unique SID identifier of the Conversation. This value can be either the sid or the unique_name of the Conversation resource.

Other Parameters

Other parameters are passed through a pointer to a FetchUserConversationParams struct

Name Type Description

Return type

ConversationsV1UserConversation

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListUserConversation

[]ConversationsV1UserConversation ListUserConversation(ctx, UserSidoptional)

Retrieve a list of all User Conversations for the User.

Path Parameters

Name Type Description
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
UserSid string The unique SID identifier of the User resource. This value can be either the sid or the identity of the User resource.

Other Parameters

Other parameters are passed through a pointer to a ListUserConversationParams struct

Name Type Description
PageSize int How many resources to return in each list page. The default is 50, and the maximum is 1000.
Limit int Max number of records to return.

Return type

[]ConversationsV1UserConversation

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateUserConversation

ConversationsV1UserConversation UpdateUserConversation(ctx, UserSidConversationSidoptional)

Update a specific User Conversation.

Path Parameters

Name Type Description
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
UserSid string The unique SID identifier of the User resource. This value can be either the sid or the identity of the User resource.
ConversationSid string The unique SID identifier of the Conversation. This value can be either the sid or the unique_name of the Conversation resource.

Other Parameters

Other parameters are passed through a pointer to a UpdateUserConversationParams struct

Name Type Description
NotificationLevel string
LastReadTimestamp time.Time The date of the last message read in conversation by the user, given in ISO 8601 format.
LastReadMessageIndex int The index of the last Message in the Conversation that the Participant has read.

Return type

ConversationsV1UserConversation

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]