LeadMagnet/leadchat
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore: Update API documentation for whatsapp templates (#8211)

Browse Source 
- Update API documentation for whatsapp templates
This commit is contained in:
Sojan Jose
2023-10-25 17:06:58 -07:00
committed by GitHub
parent 8c67ea56e7
commit b6831d464e
3 changed files with 126 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
swagger/definitions/request/conversation/create_message.yml
View File

@@ -19,3 +19,24 @@ properties:
content_attributes:
type: object
description: attributes based on your content type
template_params:
type: object
description: The template params for the message in case of whatsapp Channel
properties:
name:
type: string
description: Name of the template
example: 'sample_issue_resolution'
category:
type: string
description: Category of the template
example: UTILITY
language:
type: string
description: Language of the template
example: en_US
processed_params:
type: object
description: The processed param values for template variables in template
example:
1: "Chatwoot"

33
swagger/paths/application/conversation/index.yml
View File

@@ -66,6 +66,9 @@ post:
required: true
schema:
type: object
required:
- source_id
- inbox_id
properties:
source_id:
type: string
@@ -93,7 +96,35 @@ post:
team_id:
type: string
description: Team Id for assigning a conversation to a team
message:
type: object
description: The initial message to be sent to the conversation
required: ['content']
properties:
content:
type: string
description: The content of the message
template_params:
type: object
description: The template params for the message in case of whatsapp Channel
properties:
name:
type: string
description: Name of the template
example: 'sample_issue_resolution'
category:
type: string
description: Category of the template
example: UTILITY
language:
type: string
description: Language of the template
example: en_US
processed_params:
type: object
description: The processed param values for template variables in template
example:
1: "Chatwoot"
responses:
200:
description: Success

73
swagger/swagger.json
View File

@@ -2840,6 +2840,10 @@
"required": true,
"schema": {
"type": "object",
"required": [
"source_id",
"inbox_id"
],
"properties": {
"source_id": {
"type": "string",
@@ -2881,6 +2885,47 @@
"team_id": {
"type": "string",
"description": "Team Id for assigning a conversation to a team"
},
"message": {
"type": "object",
"description": "The initial message to be sent to the conversation",
"required": [
"content"
],
"properties": {
"content": {
"type": "string",
"description": "The content of the message"
},
"template_params": {
"type": "object",
"description": "The template params for the message in case of whatsapp Channel",
"properties": {
"name": {
"type": "string",
"description": "Name of the template",
"example": "sample_issue_resolution"
},
"category": {
"type": "string",
"description": "Category of the template",
"example": "UTILITY"
},
"language": {
"type": "string",
"description": "Language of the template",
"example": "en_US"
},
"processed_params": {
"type": "object",
"description": "The processed param values for template variables in template",
"example": {
"1": "Chatwoot"
}
}
}
}
}
}
}
}
@@ -6246,6 +6291,34 @@
"content_attributes": {
"type": "object",
"description": "attributes based on your content type"
},
"template_params": {
"type": "object",
"description": "The template params for the message in case of whatsapp Channel",
"properties": {
"name": {
"type": "string",
"description": "Name of the template",
"example": "sample_issue_resolution"
},
"category": {
"type": "string",
"description": "Category of the template",
"example": "UTILITY"
},
"language": {
"type": "string",
"description": "Language of the template",
"example": "en_US"
},
"processed_params": {
"type": "object",
"description": "The processed param values for template variables in template",
"example": {
"1": "Chatwoot"
}
}
}
}
}
},