github.com/grokify/go-ringcentral-client@v0.3.31/engagedigital/v1/client/docs/ContentsApi.md (about)

     1  # \ContentsApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CategorizeContent**](ContentsApi.md#CategorizeContent) | **Put** /contents/{contentId}/update_categories | Categorizing a content
     8  [**CreateContent**](ContentsApi.md#CreateContent) | **Post** /contents | Creating a content
     9  [**GetAllContents**](ContentsApi.md#GetAllContents) | **Get** /contents | Contents
    10  [**GetContent**](ContentsApi.md#GetContent) | **Get** /contents/{contentId} | Getting a content from its id
    11  [**IgnoreContent**](ContentsApi.md#IgnoreContent) | **Put** /contents/{contentId}/ignore | Ignoring a content
    12  
    13  
    14  
    15  ## CategorizeContent
    16  
    17  > Content CategorizeContent(ctx, contentId, categoryIds)
    18  Categorizing a content
    19  
    20  This method updates the categories of a content. If token’s user does not have “read” on this content’s source a 404 HTTP response will be returned.  Authorization​: no.
    21  
    22  ### Required Parameters
    23  
    24  
    25  Name | Type | Description  | Notes
    26  ------------- | ------------- | ------------- | -------------
    27  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    28  **contentId** | **string**|  | 
    29  **categoryIds** | [**[]string**](string.md)| An array containing the new categories to set on the content. | 
    30  
    31  ### Return type
    32  
    33  [**Content**](Content.md)
    34  
    35  ### Authorization
    36  
    37  No authorization required
    38  
    39  ### HTTP request headers
    40  
    41  - **Content-Type**: Not defined
    42  - **Accept**: application/json
    43  
    44  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    45  [[Back to Model list]](../README.md#documentation-for-models)
    46  [[Back to README]](../README.md)
    47  
    48  
    49  ## CreateContent
    50  
    51  > Content CreateContent(ctx, body, optional)
    52  Creating a content
    53  
    54  This method allows you to create an new content. It can be a reply to another content or a content that initiate discussion. It use token’s user as content user if he is authorized. Content will be created in Dimelo Digital and pushed asynchronously to the source.  Replying to a customer content is usually possible (unless the source/conversation is read only).  Composing a content on the contrary depend on the source itself: * The source may not support it (and be purely reactive like Instagram, Messenger ...) * Some sources (usually public account) like Twitter or Facebook page allows to publish content without targeting specific individuals. * Some sources (usually non public media) require specific targeting (phone number for SMS, email address for email, customer_id ...) to be able to create a content. This is source specific and detailed under the generic parameters.  Authorization​: only users that can reply or initiate discussion (= compose) on given source. it renders also an error if in_reply_to isn’t synchronized or if in_reply_to content is not under an ​open intervention.
    55  
    56  ### Required Parameters
    57  
    58  
    59  Name | Type | Description  | Notes
    60  ------------- | ------------- | ------------- | -------------
    61  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    62  **body** | **string**| The content’s body. This parameter is mandatory. | 
    63   **optional** | ***CreateContentOpts** | optional parameters | nil if no parameters
    64  
    65  ### Optional Parameters
    66  
    67  Optional parameters are passed through a pointer to a CreateContentOpts struct
    68  
    69  
    70  Name | Type | Description  | Notes
    71  ------------- | ------------- | ------------- | -------------
    72  
    73   **authorId** | **optional.String**| The identity id of content. This parameter is not mandatory, by default it use the token’s user first identity on source. | 
    74   **inReplyToId** | **optional.String**| The content’s id you want to reply to. If omitted, a new discussion will be created. If source does not support to initiate discussion this parameter is mandatory. | 
    75   **private** | **optional.Int32**| Created contents are public by default, set this parameter to \"1\" in order to create a private reply. It is NOT supported on every source. | 
    76   **sourceId** | **optional.String**| The source to create content to. If you specify `in_reply_to_id` parameter, source will be determined from it. Otherwise, this parameter is mandatory. | 
    77   **attachmentIds** | [**optional.Interface of []string**](string.md)| An array containing the attachments’ ids that need to be attached to this content. | 
    78   **title** | **optional.String**| For an email source. The subject of the email. This parameter is mandatory when initiating a discussion. | 
    79   **to** | [**optional.Interface of []string**](string.md)| For an email or SMS source. For an email, an array containing the email addresses used in the “To” section of the email. This parameter is mandatory when initiating a discussion. For a SMS, the number the SMS will be sent to. It must start with 00 or +, example: +33634231224 or 0033634231224. This parameter is mandatory when initiating a discussion. | 
    80   **cc** | [**optional.Interface of []string**](string.md)| For an email source. An array containing the email addresses used in the “Cc” section of the email. | 
    81   **bcc** | [**optional.Interface of []string**](string.md)| For an email source. An array containing the email addresses used in the “Bcc” section of the email. | 
    82  
    83  ### Return type
    84  
    85  [**Content**](Content.md)
    86  
    87  ### Authorization
    88  
    89  No authorization required
    90  
    91  ### HTTP request headers
    92  
    93  - **Content-Type**: Not defined
    94  - **Accept**: application/json
    95  
    96  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    97  [[Back to Model list]](../README.md#documentation-for-models)
    98  [[Back to README]](../README.md)
    99  
   100  
   101  ## GetAllContents
   102  
   103  > GetAllContentsResponse GetAllContents(ctx, optional)
   104  Contents
   105  
   106  This method renders contents ordered by creation date (descending). Only contents in sources where token’s user has “read” permission are returned.  Authorization​: no.
   107  
   108  ### Required Parameters
   109  
   110  
   111  Name | Type | Description  | Notes
   112  ------------- | ------------- | ------------- | -------------
   113  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   114   **optional** | ***GetAllContentsOpts** | optional parameters | nil if no parameters
   115  
   116  ### Optional Parameters
   117  
   118  Optional parameters are passed through a pointer to a GetAllContentsOpts struct
   119  
   120  
   121  Name | Type | Description  | Notes
   122  ------------- | ------------- | ------------- | -------------
   123   **q** | **optional.String**| To filter contents on given query. Query works exactly like threads query but only have those keywords: intervention,identity, identity_group, source, status_in, thread or text. Order can be created_at.desc (default) or created_at.asc. e.g. q=intervention:\"7f946431b6eebffafae642cc\"%20source:\"d19c81948c137d86dac77216\" Please refer to ​Search & filtering parameters​ for more details. | 
   124   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
   125   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
   126  
   127  ### Return type
   128  
   129  [**GetAllContentsResponse**](GetAllContentsResponse.md)
   130  
   131  ### Authorization
   132  
   133  No authorization required
   134  
   135  ### HTTP request headers
   136  
   137  - **Content-Type**: Not defined
   138  - **Accept**: application/json
   139  
   140  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   141  [[Back to Model list]](../README.md#documentation-for-models)
   142  [[Back to README]](../README.md)
   143  
   144  
   145  ## GetContent
   146  
   147  > Content GetContent(ctx, contentId)
   148  Getting a content from its id
   149  
   150  This method renders a content from given id. If token’s user does not have “read” on content’s source a 404 HTTP response will be returned.  Authorization​: no.
   151  
   152  ### Required Parameters
   153  
   154  
   155  Name | Type | Description  | Notes
   156  ------------- | ------------- | ------------- | -------------
   157  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   158  **contentId** | **string**|  | 
   159  
   160  ### Return type
   161  
   162  [**Content**](Content.md)
   163  
   164  ### Authorization
   165  
   166  No authorization required
   167  
   168  ### HTTP request headers
   169  
   170  - **Content-Type**: Not defined
   171  - **Accept**: application/json
   172  
   173  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   174  [[Back to Model list]](../README.md#documentation-for-models)
   175  [[Back to README]](../README.md)
   176  
   177  
   178  ## IgnoreContent
   179  
   180  > Content IgnoreContent(ctx, contentId)
   181  Ignoring a content
   182  
   183  Ignores a content. If token’s user does not have “read” on content’s source a 404 HTTP response will be returned.  Authorization​: no.
   184  
   185  ### Required Parameters
   186  
   187  
   188  Name | Type | Description  | Notes
   189  ------------- | ------------- | ------------- | -------------
   190  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   191  **contentId** | **string**|  | 
   192  
   193  ### Return type
   194  
   195  [**Content**](Content.md)
   196  
   197  ### Authorization
   198  
   199  No authorization required
   200  
   201  ### HTTP request headers
   202  
   203  - **Content-Type**: Not defined
   204  - **Accept**: application/json
   205  
   206  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   207  [[Back to Model list]](../README.md#documentation-for-models)
   208  [[Back to README]](../README.md)
   209