Zalo SDK .NET

https://github.com/zaloplatform/zalodotnetsdk
Admin
A comprehensive SDK for building chatbots, shops, articles, social APIs, login, official account...
Tokens:23,609
Snippets:113
Trust Score:6.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Upload Video for Article using Zalo .NET SDK

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

This process involves two steps: preparing the video upload to get a token, and then verifying the upload completion using that token to get the video ID. Ensure the video file path is correct.

```csharp
using ZaloDotNetSDK;
using ZaloDotNetSDK.entities;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

// Step 1: Prepare video upload
ZaloFile videoFile = new ZaloFile("C:\\videos\\demo.mp4");

JObject prepareResult = client.prepareUploadVideoForArticle(videoFile);

if (prepareResult["error"].ToObject<int>() == 0)
{
    string uploadToken = prepareResult["data"]["token"].ToString();
    Console.WriteLine($"Upload initiated. Token: {uploadToken}");

    // Step 2: Verify upload completion (poll until complete)
    JObject verifyResult = client.verifyUploadVideoForArticle(uploadToken);

    if (verifyResult["error"].ToObject<int>() == 0)
    {
        string videoId = verifyResult["data"]["video_id"].ToString();
        Console.WriteLine($"Video ready. Video ID: {videoId}");
    }
}
// Response: {"error":0,"message":"Success","data":{"token":"upload_token","video_id":"vid123"}}
```

--------------------------------

### GET /product

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieve detailed information about a specific product.

```APIDOC
## GET /product

### Description
Retrieve detailed information about a specific product by its ID.

### Parameters
#### Path Parameters
- **productId** (string) - Required - The ID of the product to retrieve.

### Response
#### Success Response (200)
- **error** (int) - Error code (0 for success)
- **data** (object) - Product details including name, price, quantity, and status

#### Response Example
{
  "error": 0,
  "message": "Success",
  "data": {
    "id": "prod123",
    "name": "T-Shirt",
    "price": 150000,
    "quantity": 100
  }
}
```

--------------------------------

### Get Product List

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieves a paginated list of products available in the shop.

```APIDOC
## Get Product List

### Description
Retrieve a paginated list of products.

### Method
GET

### Endpoint
/v2/shop/get_slice_product

### Parameters
#### Query Parameters
- **offset** (int) - Required - The starting index for pagination.
- **limit** (int) - Required - The maximum number of products to return.

### Response
#### Success Response (200)
- **error** (int) - Indicates if an error occurred (0 for success).
- **message** (string) - A message describing the result of the operation.
- **data** (object) - Contains the product data.
  - **total** (int) - The total number of products available.
  - **products** (array) - A list of product objects.
    - **id** (string) - The unique identifier for the product.
    - **name** (string) - The name of the product.
    - **price** (int) - The price of the product.

### Response Example
```json
{
  "error": 0,
  "message": "Success",
  "data": {
    "total": 100,
    "products": [
      {
        "id": "1",
        "name": "Product 1",
        "price": 100000
      },
      ...
    ]
  }
}
```
```

--------------------------------

### Install Zalo SDK via NuGet

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Use the NuGet Package Manager to add the Zalo SDK to your .NET project.

```powershell
Install-Package vng.zalo.ZaloDotNetSDK
```

--------------------------------

### Get Product List with Zalo .NET SDK

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieves a paginated list of products from the shop. Requires an OA access token. Handles success and error responses.

```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

int offset = 0;
int limit = 20;

JObject products = client.getSliceProduct(offset, limit);

if (products["error"].ToObject<int>() == 0)
{
    Console.WriteLine($"Total products: {products["data"]["total"]}");
    foreach (var product in products["data"]["products"])
    {
        Console.WriteLine($"ID: {product["id"]}, Name: {product["name"]}, Price: {product["price"]}");
    }
}
// Response: {"error":0,"message":"Success","data":{"total":100,"products":[{"id":"1","name":"Product 1","price":100000},...]}}
```

--------------------------------

### GET /articles

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieves a paginated list of articles, which can be filtered by type (normal or video).

```APIDOC
## Get Article List

### Description
Retrieve a paginated list of articles.

### Method
GET

### Endpoint
/articles

### Query Parameters
- **offset** (int) - Required - The starting index for the list of articles.
- **limit** (int) - Required - The maximum number of articles to return.
- **type** (string) - Optional - The type of articles to retrieve ('normal' or 'video'). Defaults to 'normal' if not specified.

### Response
#### Success Response (200)
- **error** (int) - 0 for success.
- **message** (string) - Success message.
- **data** (object) - Contains the list of articles.
  - **total** (int) - The total number of articles available.
  - **medias** (array) - An array of article objects.
    - **id** (string) - The article ID.
    - **title** (string) - The article title.
    - ... (other article fields)

#### Response Example
```json
{
  "error": 0,
  "message": "Success",
  "data": {
    "total": 50,
    "medias": [
      {
        "id": "1",
        "title": "Article 1"
      },
      "..."
    ]
  }
}
```
```

--------------------------------

### Tag Management - Get All Tags

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieves a list of all tags associated with the Official Account.

```APIDOC
## Tag Management - Get All Tags

### Description
Retrieve all tags for the Official Account.

### Method
GET (Assumed, as it retrieves data)

### Endpoint
/v2/tag/get_all (Assumed based on SDK method name)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **error** (integer) - Error code, 0 for success.
- **message** (string) - Success or error message.
- **data** (array) - An array of tag objects.
  - **name** (string) - The name of the tag.
  - **followers** (integer) - The number of followers associated with the tag.

#### Response Example
```json
{
  "error": 0,
  "message": "Success",
  "data": [
    {
      "name": "VIP",
      "followers": 100
    },
    {
      "name": "New",
      "followers": 50
    }
  ]
}
```
```

--------------------------------

### Get Product Details using Zalo .NET SDK

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieve detailed information for a specific product using its ID. This is useful for displaying product information or checking stock levels. Ensure the product ID is correct.

```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

string productId = "PRODUCT_ID";

JObject product = client.getdetailProduct(productId);

if (product["error"].ToObject<int>() == 0)
{
    var data = product["data"];
    Console.WriteLine($"Name: {data["name"]}");
    Console.WriteLine($"Price: {data["price"]}");
    Console.WriteLine($"Stock: {data["quantity"]}");
    Console.WriteLine($"Status: {data["status"]}");
}
// Response: {"error":0,"message":"Success","data":{"id":"prod123","name":"T-Shirt","price":150000,"quantity":100,...}}
```

--------------------------------

### Get Order Details

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieves detailed information about a specific order using its ID.

```APIDOC
## Get Order Details

### Description
Retrieve detailed information about a specific order.

### Method
GET

### Endpoint
/v2/shop/get_detail_order

### Parameters
#### Query Parameters
- **order_id** (string) - Required - The ID of the order to retrieve.

### Response
#### Success Response (200)
- **error** (int) - Indicates if an error occurred (0 for success).
- **message** (string) - A message describing the result of the operation.
- **data** (object) - Contains the order details.
  - **order_id** (string) - The ID of the order.
  - **status** (int) - The current status of the order.
  - **customer** (object) - Information about the customer.
    - **name** (string) - The customer's name.
  - **total_amount** (int) - The total amount of the order.
  - ... (other order details)

### Response Example
```json
{
  "error": 0,
  "message": "Success",
  "data": {
    "order_id": "order123",
    "status": 1,
    "customer": {
      "name": "John"
    },
    "total_amount": 300000,
    ...
  }
}
```
```

--------------------------------

### Get Order List

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieves a paginated list of orders, optionally filtered by status.

```APIDOC
## Get Order List

### Description
Retrieve a paginated list of orders filtered by status.

### Method
GET

### Endpoint
/v2/shop/get_slice_order

### Parameters
#### Query Parameters
- **offset** (int) - Required - The starting index for pagination.
- **limit** (int) - Required - The maximum number of orders to return.
- **status** (int) - Optional - Filters orders by status (1=pending, 2=confirmed, 3=shipping, 4=completed, 5=cancelled).

### Response
#### Success Response (200)
- **error** (int) - Indicates if an error occurred (0 for success).
- **message** (string) - A message describing the result of the operation.
- **data** (object)
  - **total** (int) - The total number of orders matching the criteria.
  - **orders** (array) - A list of order objects.
    - **order_id** (string) - The ID of the order.
    - **status** (int) - The status of the order.
    - ... (other order details)

### Response Example
```json
{
  "error": 0,
  "message": "Success",
  "data": {
    "total": 50,
    "orders": [
      {
        "order_id": "ord1",
        "status": 1
      },
      ...
    ]
  }
}
```
```

--------------------------------

### Get Order List with Zalo .NET SDK

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieves a paginated list of orders, filterable by status. Requires an OA access token and pagination parameters. Iterates through the orders and prints their IDs and statuses.

```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

int offset = 0;
int limit = 20;
int status = 1;  // 1=pending, 2=confirmed, 3=shipping, 4=completed, 5=cancelled

JObject orders = client.getSliceOrder(offset, limit, status);

if (orders["error"].ToObject<int>() == 0)
{
    Console.WriteLine($"Total orders: {orders["data"]["total"]}");
    foreach (var order in orders["data"]["orders"])
    {
        Console.WriteLine($"Order ID: {order["order_id"]}, Status: {order["status"]}");
    }
}
// Response: {"error":0,"message":"Success","data":{"total":50,"orders":[{"order_id":"ord1","status":1},...]}}
```

--------------------------------

### Get List of Followers

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieve a paginated list of all followers for the Official Account.

```APIDOC
## Get List of Followers

### Description
Retrieve a paginated list of Official Account followers.

### Method
GET (Implied by SDK method)

### Endpoint
Not explicitly defined, SDK method `getListFollower` is used.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (parameters are passed directly to the SDK method)

### Request Example
```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

int offset = 0;
int count = 50;  // Max 50 per request

JObject followers = client.getListFollower(offset, count);

if (followers["error"].ToObject<int>() == 0)
{
    var data = followers["data"];
    Console.WriteLine($"Total followers: {data["total"]}");
    foreach (var follower in data["followers"])
    {
        Console.WriteLine($"User ID: {follower["user_id"]}");
    }
}
```

### Response
#### Success Response (200)
- **error** (integer) - Error code, 0 for success.
- **message** (string) - Success message.
- **data** (object) - Contains follower list details.
  - **total** (integer) - The total number of followers.
  - **followers** (array) - An array of follower objects.
    - **user_id** (string) - The Zalo User ID of a follower.

#### Response Example
```json
{
  "error": 0,
  "message": "Success",
  "data": {
    "total": 1000,
    "followers": [
      {
        "user_id": "123"
      },
      {
        "user_id": "456"
      }
    ]
  }
}
```
```

--------------------------------

### Get Order Details with Zalo .NET SDK

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieves detailed information for a specific order using its ID. Requires an OA access token. Parses and displays key order details like ID, status, customer name, and total amount.

```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

string orderId = "ORDER_ID";

JObject order = client.getdetailOrder(orderId);

if (order["error"].ToObject<int>() == 0)
{
    var data = order["data"];
    Console.WriteLine($"Order ID: {data["order_id"]}");
    Console.WriteLine($"Status: {data["status"]}");
    Console.WriteLine($"Customer: {data["customer"]["name"]}");
    Console.WriteLine($"Total: {data["total_amount"]}");
}
// Response: {"error":0,"message":"Success","data":{"order_id":"order123","status":1,"customer":{"name":"John"},"total_amount":300000,...}}
```

--------------------------------

### Get List of Followers in C#

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieves a paginated list of followers. The count parameter is limited to a maximum of 50 per request.

```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

int offset = 0;
int count = 50;  // Max 50 per request

JObject followers = client.getListFollower(offset, count);

if (followers["error"].ToObject<int>() == 0)
{
    var data = followers["data"];
    Console.WriteLine($"Total followers: {data["total"]}");
    foreach (var follower in data["followers"])
    {
        Console.WriteLine($"User ID: {follower["user_id"]}");
    }
}
// Response: {"error":0,"message":"Success","data":{"total":1000,"followers":[{"user_id":"123"},{"user_id":"456"}...]}}
```

--------------------------------

### Get All Tags for Official Account

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieves a list of all tags associated with the Official Account. Useful for managing follower segments.

```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

JObject tags = client.getAllTagOfOfficialAccount();

if (tags["error"].ToObject<int>() == 0)
{
    foreach (var tag in tags["data"])
    {
        Console.WriteLine($"Tag Name: {tag["name"]}");
        Console.WriteLine($"Follower Count: {tag["followers"]}");
    }
}
// Response: {"error":0,"message":"Success","data":[{"name":"VIP","followers":100},{"name":"New","followers":50}]}
```

--------------------------------

### GET /article/{articleId}

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieves detailed information about a specific article using its unique ID.

```APIDOC
## Get Article Details

### Description
Retrieve detailed information about a specific article.

### Method
GET

### Endpoint
/article/{articleId}

### Path Parameters
- **articleId** (string) - Required - The ID of the article to retrieve.

### Response
#### Success Response (200)
- **error** (int) - 0 for success.
- **message** (string) - Success message.
- **data** (object) - Contains article details.
  - **id** (string) - The article ID.
  - **title** (string) - The article title.
  - **author** (string) - The article author.
  - **status** (string) - The article status (e.g., "show").
  - **total_view** (int) - The total number of views for the article.
  - ... (other article fields)

#### Response Example
```json
{
  "error": 0,
  "message": "Success",
  "data": {
    "id": "123",
    "title": "Article Title",
    "author": "Author",
    "status": "show",
    "total_view": 1000,
    "...": "..."
  }
}
```
```

--------------------------------

### Get Follower Profile in C#

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieves profile details for a specific follower using their Zalo ID. Check the error field in the response to verify success.

```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

string userId = "USER_ZALO_ID";

JObject profile = client.getProfileOfFollower(userId);

if (profile["error"].ToObject<int>() == 0)
{
    var data = profile["data"];
    Console.WriteLine($"Display Name: {data["display_name"]}");
    Console.WriteLine($"User ID: {data["user_id"]}");
    Console.WriteLine($"Avatar: {data["avatar"]}");
    Console.WriteLine($"Is Follower: {data["user_is_follower"]}");
}
// Response: {"error":0,"message":"Success","data":{"display_name":"John Doe","user_id":"123","avatar":"https://...","user_is_follower":true,...}}
```

--------------------------------

### Create Product using Zalo .NET SDK

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Create a new product in your Official Account's shop. This includes defining product details, variations, and status. Ensure all required fields for Product and Variation entities are populated.

```csharp
using ZaloDotNetSDK;
using ZaloDotNetSDK.entities.shop;
using Newtonsoft.Json.Linq;
using System.Collections.Generic;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

// Create product variations
List<Variation> variations = new List<Variation>
{
    new Variation
    {
        Name = "Red - Small",
        Code = "PROD-001-RED-S",
        Price = 150000,
        Quantity = 100,
        Status = ShopStatus.SHOW,
        VariationDefault = true,
        Attributes = new List<string> { "attr_color_red", "attr_size_s" },
        PackageSize = new PackageSize(500, 20, 15, 5)  // weight, length, width, height
    },
    new Variation
    {
        Name = "Blue - Medium",
        Code = "PROD-001-BLUE-M",
        Price = 160000,
        Quantity = 50,
        Status = ShopStatus.SHOW,
        VariationDefault = false,
        Attributes = new List<string> { "attr_color_blue", "attr_size_m" },
        PackageSize = new PackageSize(500, 20, 15, 5)
    }
};

Product product = new Product
{
    Name = "Premium T-Shirt",
    Description = "High quality cotton t-shirt with modern design",
    Code = "PROD-001",
    Price = 150000,
    Quantity = 150,
    Industry = 1,  // Fashion category
    Categories = new List<string> { "category_id_1", "category_id_2" },
    Photos = new List<string> { "photo_id_1", "photo_id_2", "photo_id_3" },
    Status = ShopStatus.SHOW,
    PackageSize = new PackageSize(500, 20, 15, 5),
    Variations = variations
};

JObject result = client.createProduct(product);

if (result["error"].ToObject<int>() == 0)
{
    string productId = result["data"]["id"].ToString();
    Console.WriteLine($"Product created. ID: {productId}");
}
// Response: {"error":0,"message":"Success","data":{"id":"prod123"}}
```

--------------------------------

### Social API - Get Invitable Friends

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Get friends who can be invited to use the app.

```APIDOC
## Social API - Get Invitable Friends

### Description
Get friends who can be invited to use the app.

### Method
GET

### Endpoint
`/v2.0/user/get_invitable_friends`

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The user's access token.
- **offset** (int) - Optional - The starting index for pagination. Defaults to 0.
- **limit** (int) - Optional - The number of friends to retrieve. Defaults to 50.
- **fields** (string) - Optional - Comma-separated list of fields to retrieve for each friend (e.g., "id,name,picture").

### Request Example
```csharp
string userAccessToken = "USER_ACCESS_TOKEN";
int offset = 0;
int limit = 50;
string fields = "id,name,picture";
JObject invitableFriends = appClient.getInvitableFriends(userAccessToken, offset, limit, fields);
```

### Response
#### Success Response (200)
- **data** (array) - List of invitable friend objects.
  - **id** (string) - Friend's unique identifier.
  - **name** (string) - Friend's name.
  - **picture** (object) - Friend's profile picture information.
- **summary** (object)
  - **total_count** (int) - Total number of invitable friends.

#### Response Example
```json
{
  "data": [
    {
      "id": "456",
      "name": "Potential User",
      "picture": {
        "data": {
          "url": "https://..."
        }
      }
    }
  ],
  "summary": {
    "total_count": 100
  }
}
```
```

--------------------------------

### POST /product

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Creates a new product in the Official Account shop.

```APIDOC
## POST /product

### Description
Create a new product in the Official Account shop with variations and package details.

### Response
#### Success Response (200)
- **error** (int) - Error code (0 for success)
- **message** (string) - Status message
- **data** (object) - Contains the created product ID

#### Response Example
{
  "error": 0,
  "message": "Success",
  "data": {
    "id": "prod123"
  }
}
```

--------------------------------

### Create Article with ZaloDotNetSDK

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Constructs an article with text, images, and video components before publishing. Requires a valid OA access token.

```csharp
using ZaloDotNetSDK;
using ZaloDotNetSDK.entities;
using ZaloDotNetSDK.entities.article;
using Newtonsoft.Json.Linq;
using System.Collections.Generic;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

// Create article body content
List<Paragraph> body = new List<Paragraph>
{
    new ParagraphText("Welcome to our latest news article. This is the introduction paragraph."),
    new ParagraphImage("https://example.com/image1.jpg", "Featured Image Caption"),
    new ParagraphText("This is the main content of the article with detailed information."),
    new ParagraphVideo("VIDEO_ID_FROM_UPLOAD", "https://example.com/thumb.jpg")
};

// Create article cover
Cover cover = new CoverPhoto("https://example.com/cover.jpg", ArticleStatus.SHOW);

// Create related media links
List<RelatedMedia> relatedMedias = new List<RelatedMedia>
{
    new RelatedMedia("RELATED_ARTICLE_ID_1"),
    new RelatedMedia("RELATED_ARTICLE_ID_2")
};

// Build article
Article article = new Article(
    title: "Breaking News: New Product Launch",
    author: "Marketing Team",
    cover: cover,
    description: "Learn about our exciting new product features and capabilities.",
    body: body,
    relatedMedias: relatedMedias,
    trackingLink: "https://tracking.example.com/article123",
    status: ArticleStatus.SHOW,
    comment: ArticleStatus.SHOW
);

JObject result = client.createArticle(article);

if (result["error"].ToObject<int>() == 0)
{
    string articleId = result["data"]["id"].ToString();
    Console.WriteLine($"Article created. ID: {articleId}");
}
// Response: {"error":0,"message":"Success","data":{"id":"article123","token":"verify_token"}}
```

--------------------------------

### Retrieve User Friends

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Get a list of friends who are also users of the application.

```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

ZaloAppInfo appInfo = new ZaloAppInfo(1234567890, "SECRET_KEY", "https://callback.url");
ZaloAppClient appClient = new ZaloAppClient(appInfo);

string userAccessToken = "USER_ACCESS_TOKEN";
int offset = 0;
int limit = 50;
string fields = "id,name,picture";

JObject friends = appClient.getFriends(userAccessToken, offset, limit, fields);

Console.WriteLine($"Total friends: {friends["summary"]["total_count"]}");
foreach (var friend in friends["data"])
{
    Console.WriteLine($"Friend: {friend["name"]} (ID: {friend["id"]})");
}
// Response: {"data":[{"id":"123","name":"Friend 1"},...],"summary":{"total_count":50}}
```

--------------------------------

### Initialize ZaloClient for Official Account

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Configure the ZaloClient with an OA access token to perform operations like profile retrieval. Enable isDebug to inspect request URLs.

```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

// Initialize with your OA access token
string accessToken = "YOUR_OA_ACCESS_TOKEN";
ZaloClient client = new ZaloClient(accessToken);

// Enable debug mode to see request URLs
client.isDebug = true;

// Get Official Account profile
JObject oaProfile = client.getProfileOfOfficialAccount();
Console.WriteLine($"OA Name: {oaProfile["data"]["name"]}");
Console.WriteLine($"OA ID: {oaProfile["data"]["oa_id"]}");
// Response: {"error":0,"message":"Success","data":{"oa_id":"123456","name":"My OA","description":"...", ...}}
```

--------------------------------

### Create Order with Zalo .NET SDK

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Creates a new order in the shop, including customer details and order items. Requires an OA access token and utilizes entity classes for customer and order items. Logs the created order ID upon success.

```csharp
using ZaloDotNetSDK;
using ZaloDotNetSDK.entities.shop;
using Newtonsoft.Json.Linq;
using System.Collections.Generic;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

// Create customer
Customer customer = new Customer
{
    Name = "John Doe",
    Phone = "+84123456789",
    User_id = "USER_ZALO_ID",
    Address = "123 Main Street",
    City = "Ho Chi Minh",
    Dictrict = "District 1"
};

// Create order items
List<OrderItem> orderItems = new List<OrderItem>
{
    new OrderItem
    {
        Product_id = "PRODUCT_ID_1",
        Quantity = 2,
        Variation_id = "VARIATION_ID_1"
    },
    new OrderItem
    {
        Product_id = "PRODUCT_ID_2",
        Quantity = 1,
        Partner_item_data = "Custom data for this item"
    }
};

Order order = new Order(customer, "Please deliver before 5 PM", orderItems);

JObject result = client.createOrder(order);

if (result["error"].ToObject<int>() == 0)
{
    string orderId = result["data"]["order_id"].ToString();
    Console.WriteLine($"Order created. ID: {orderId}");
}
// Response: {"error":0,"message":"Success","data":{"order_id":"order123"}}
```

--------------------------------

### Retrieve Category List in C#

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Fetches a paginated list of product categories.

```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

int offset = 0;
int limit = 50;

JObject categories = client.getSliceCategory(offset, limit);

if (categories["error"].ToObject<int>() == 0)
{
    foreach (var category in categories["data"]["categories"])
    {
        Console.WriteLine($"ID: {category["id"]}, Name: {category["name"]}");
    }
}
// Response: {"error":0,"message":"Success","data":{"categories":[{"id":"cat1","name":"Electronics"},...]}}
```

--------------------------------

### Social API - Get User Profile

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieve the authenticated user's profile information.

```APIDOC
## Social API - Get User Profile

### Description
Retrieve the authenticated user's profile information.

### Method
GET

### Endpoint
`/v2.0/user/get_profile`

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The user's access token.
- **fields** (string) - Optional - Comma-separated list of fields to retrieve (e.g., "id,name,picture,birthday,gender").

### Request Example
```csharp
string userAccessToken = "USER_ACCESS_TOKEN";
string fields = "id,name,picture,birthday,gender";
JObject profile = appClient.getProfile(userAccessToken, fields);
```

### Response
#### Success Response (200)
- **id** (string) - User's unique identifier.
- **name** (string) - User's name.
- **picture** (object) - User's profile picture information.
  - **data** (object)
    - **url** (string) - URL of the profile picture.
- **birthday** (string) - User's birthday (format YYYY/MM/DD).
- **gender** (string) - User's gender.

#### Response Example
```json
{
  "id": "123456789",
  "name": "John Doe",
  "picture": {
    "data": {
      "url": "https://..."
    }
  },
  "birthday": "1990/01/01",
  "gender": "male"
}
```
```

--------------------------------

### Initialize ZaloAppClient for Social API

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Set up ZaloAppClient with app credentials to handle OAuth flows and exchange authorization codes for access tokens.

```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

// Initialize with your app credentials
ZaloAppInfo appInfo = new ZaloAppInfo(
    appId: 1234567890,
    secretKey: "YOUR_APP_SECRET_KEY",
    callbackUrl: "https://yourapp.com/callback"
);
ZaloAppClient appClient = new ZaloAppClient(appInfo);

// Generate login URL for OAuth flow
string loginUrl = appClient.getLoginUrl();
Console.WriteLine($"Redirect user to: {loginUrl}");
// Output: https://oauth.zaloapp.com/v3/auth?app_id=1234567890&redirect_uri=https://yourapp.com/callback

// After user authorizes, exchange code for access token
string oauthCode = "CODE_FROM_CALLBACK";
JObject tokenResponse = appClient.getAccessToken(oauthCode);
string userAccessToken = tokenResponse["access_token"].ToString();
// Response: {"access_token":"USER_ACCESS_TOKEN","expires_in":3600}
```

--------------------------------

### Create Order

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Creates a new order in the shop with specified customer details and items.

```APIDOC
## Create Order

### Description
Create a new order in the shop.

### Method
POST

### Endpoint
/v2/shop/create_order

### Parameters
#### Request Body
- **customer** (object) - Required - Information about the customer.
  - **name** (string) - Required - The customer's name.
  - **phone** (string) - Required - The customer's phone number.
  - **user_id** (string) - Optional - The Zalo user ID of the customer.
  - **address** (string) - Optional - The customer's address.
  - **city** (string) - Optional - The customer's city.
  - **district** (string) - Optional - The customer's district.
- **description** (string) - Optional - A note or description for the order.
- **order_items** (array) - Required - A list of items included in the order.
  - **product_id** (string) - Required - The ID of the product.
  - **quantity** (int) - Required - The quantity of the product.
  - **variation_id** (string) - Optional - The ID of the product variation.
  - **partner_item_data** (string) - Optional - Custom data for the item.

### Request Example
```json
{
  "customer": {
    "name": "John Doe",
    "phone": "+84123456789",
    "user_id": "USER_ZALO_ID",
    "address": "123 Main Street",
    "city": "Ho Chi Minh",
    "district": "District 1"
  },
  "description": "Please deliver before 5 PM",
  "order_items": [
    {
      "product_id": "PRODUCT_ID_1",
      "quantity": 2,
      "variation_id": "VARIATION_ID_1"
    },
    {
      "product_id": "PRODUCT_ID_2",
      "quantity": 1,
      "partner_item_data": "Custom data for this item"
    }
  ]
}
```

### Response
#### Success Response (200)
- **error** (int) - Indicates if an error occurred (0 for success).
- **message** (string) - A message describing the result of the operation.
- **data** (object)
  - **order_id** (string) - The ID of the newly created order.

### Response Example
```json
{
  "error": 0,
  "message": "Success",
  "data": {
    "order_id": "order123"
  }
}
```
```

--------------------------------

### Create Video Article with ZaloDotNetSDK

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Publishes a video-centric article using a previously uploaded video ID.

```csharp
using ZaloDotNetSDK;
using ZaloDotNetSDK.entities;
using ZaloDotNetSDK.entities.article;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

VideoArticle videoArticle = new VideoArticle(
    title: "Product Demo Video",
    description: "Watch our comprehensive product demonstration",
    video_id: "UPLOADED_VIDEO_ID",
    avatar: "https://example.com/video-thumbnail.jpg",
    comment: ArticleStatus.SHOW
);

JObject result = client.createVideoArticle(videoArticle);

Console.WriteLine($"Video article created: {result}");
// Response: {"error":0,"message":"Success","data":{"id":"video_article_123"}}
```

--------------------------------

### Get Conversation with User

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieve the message history for a specific conversation with a user, paginated by offset and count.

```APIDOC
## Get Conversation with User

### Description
Retrieve the message history for a specific user conversation.

### Method
GET (Implied by SDK method)

### Endpoint
Not explicitly defined, SDK method `getListConversationWithUser` is used.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (parameters are passed directly to the SDK method)

### Request Example
```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

long userId = 123456789;
int offset = 0;
int count = 10;

JObject conversation = client.getListConversationWithUser(userId, offset, count);

if (conversation["error"].ToObject<int>() == 0)
{
    foreach (var message in conversation["data"])
    {
        Console.WriteLine($"Message ID: {message["message_id"]}");
        Console.WriteLine($"From: {message["from_id"]}");
        Console.WriteLine($"Content: {message["message"]}");
    }
}
```

### Response
#### Success Response (200)
- **error** (integer) - Error code, 0 for success.
- **message** (string) - Success message.
- **data** (array) - An array of message objects within the conversation.
  - **message_id** (string) - The ID of the message.
  - **from_id** (string) - The ID of the sender.
  - **message** (string) - The content of the message.

#### Response Example
```json
{
  "error": 0,
  "message": "Success",
  "data": [
    {
      "message_id": "msg1",
      "from_id": "user123",
      "message": "Hello",
      ...
    },
    ...
  ]
}
```
```

--------------------------------

### Get Recent Chats

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieve a list of recent chat conversations with users, including the last message text.

```APIDOC
## Get Recent Chats

### Description
Retrieve a list of recent chat conversations.

### Method
GET (Implied by SDK method)

### Endpoint
Not explicitly defined, SDK method `getListRecentChat` is used.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (parameters are passed directly to the SDK method)

### Request Example
```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

int offset = 0;
int count = 20;

JObject recentChats = client.getListRecentChat(offset, count);

if (recentChats["error"].ToObject<int>() == 0)
{
    foreach (var chat in recentChats["data"])
    {
        Console.WriteLine($"User ID: {chat["user_id"]}");
        Console.WriteLine($"Last Message: {chat["last_message_text"]}");
    }
}
```

### Response
#### Success Response (200)
- **error** (integer) - Error code, 0 for success.
- **message** (string) - Success message.
- **data** (array) - An array of recent chat objects.
  - **user_id** (string) - The Zalo User ID of the conversation partner.
  - **last_message_text** (string) - The text of the last message in the conversation.

#### Response Example
```json
{
  "error": 0,
  "message": "Success",
  "data": [
    {
      "user_id": "123",
      "last_message_text": "Hello",
      ...
    },
    ...
  ]
}
```
```

--------------------------------

### Update Product using Zalo .NET SDK

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Modify an existing product in your Official Account's shop. Provide the product ID and the updated fields. Ensure the product ID is valid.

```csharp
using ZaloDotNetSDK;
using ZaloDotNetSDK.entities.shop;
using Newtonsoft.Json.Linq;
using System.Collections.Generic;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

Product product = new Product
{
    Id = "EXISTING_PRODUCT_ID",
    Name = "Premium T-Shirt - Updated",
    Description = "Updated description with new features",
    Code = "PROD-001",
    Price = 175000,  // New price
    Quantity = 200,
    Industry = 1,
    Photos = new List<string> { "photo_id_1", "photo_id_new" },
    Status = ShopStatus.SHOW,
    PackageSize = new PackageSize(500, 20, 15, 5)
};

JObject result = client.updateProduct(product);

Console.WriteLine($"Product updated: {result}");
// Response: {"error":0,"message":"Success"}
```

--------------------------------

### Get Follower Profile

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieve detailed profile information for a specific follower using their Zalo User ID.

```APIDOC
## Get Follower Profile

### Description
Retrieve profile information for a specific follower.

### Method
GET (Implied by SDK method)

### Endpoint
Not explicitly defined, SDK method `getProfileOfFollower` is used.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (parameters are passed directly to the SDK method)

### Request Example
```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

string userId = "USER_ZALO_ID";

JObject profile = client.getProfileOfFollower(userId);

if (profile["error"].ToObject<int>() == 0)
{
    var data = profile["data"];
    Console.WriteLine($"Display Name: {data["display_name"]}");
    Console.WriteLine($"User ID: {data["user_id"]}");
    Console.WriteLine($"Avatar: {data["avatar"]}");
    Console.WriteLine($"Is Follower: {data["user_is_follower"]}");
}
```

### Response
#### Success Response (200)
- **error** (integer) - Error code, 0 for success.
- **message** (string) - Success message.
- **data** (object) - Contains follower profile details.
  - **display_name** (string) - The follower's display name.
  - **user_id** (string) - The follower's Zalo User ID.
  - **avatar** (string) - URL to the follower's avatar.
  - **user_is_follower** (boolean) - Indicates if the user is a follower.

#### Response Example
```json
{
  "error": 0,
  "message": "Success",
  "data": {
    "display_name": "John Doe",
    "user_id": "123",
    "avatar": "https://...",
    "user_is_follower": true
  }
}
```
```

--------------------------------

### Social API - Get User's Friends

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Retrieve the list of user's friends who also use the app.

```APIDOC
## Social API - Get User's Friends

### Description
Retrieve the list of user's friends who also use the app.

### Method
GET

### Endpoint
`/v2.0/user/get_friends`

### Parameters
#### Query Parameters
- **access_token** (string) - Required - The user's access token.
- **offset** (int) - Optional - The starting index for pagination. Defaults to 0.
- **limit** (int) - Optional - The number of friends to retrieve. Defaults to 50.
- **fields** (string) - Optional - Comma-separated list of fields to retrieve for each friend (e.g., "id,name,picture").

### Request Example
```csharp
string userAccessToken = "USER_ACCESS_TOKEN";
int offset = 0;
int limit = 50;
string fields = "id,name,picture";
JObject friends = appClient.getFriends(userAccessToken, offset, limit, fields);
```

### Response
#### Success Response (200)
- **data** (array) - List of friend objects.
  - **id** (string) - Friend's unique identifier.
  - **name** (string) - Friend's name.
  - **picture** (object) - Friend's profile picture information.
- **summary** (object)
  - **total_count** (int) - Total number of friends.

#### Response Example
```json
{
  "data": [
    {
      "id": "123",
      "name": "Friend 1",
      "picture": {
        "data": {
          "url": "https://..."
        }
      }
    }
  ],
  "summary": {
    "total_count": 50
  }
}
```
```

--------------------------------

### Upload Shop Image in C#

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Uploads an image file for use in products or categories, requiring a ZaloFile object.

```csharp
using ZaloDotNetSDK;
using ZaloDotNetSDK.entities;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

ZaloFile imageFile = new ZaloFile("C:\\images\\product-photo.jpg");
imageFile.setMediaTypeHeader("image/jpeg");

// Upload type: "product" or "category"
string uploadType = "product";

JObject result = client.uploadImageForShopAPI(imageFile, uploadType);

if (result["error"].ToObject<int>() == 0)
{
    string photoId = result["data"]["id"].ToString();
    Console.WriteLine($"Image uploaded. Photo ID: {photoId}");
}
// Response: {"error":0,"message":"Success","data":{"id":"photo123"}}
```

--------------------------------

### Search Product by Code with Zalo .NET SDK

Source: https://context7.com/zaloplatform/zalodotnetsdk/llms.txt

Searches for products using their product code. Requires an OA access token and specifies pagination parameters. Iterates through found products.

```csharp
using ZaloDotNetSDK;
using Newtonsoft.Json.Linq;

ZaloClient client = new ZaloClient("YOUR_OA_ACCESS_TOKEN");

int offset = 0;
int limit = 10;
string productCode = "PROD-001";

JObject searchResult = client.searchProductByProductCode(offset, limit, productCode);

if (searchResult["error"].ToObject<int>() == 0)
{
    foreach (var product in searchResult["data"]["products"])
    {
        Console.WriteLine($"Found: {product["name"]} (ID: {product["id"]})");
    }
}
// Response: {"error":0,"message":"Success","data":{"products":[{"id":"prod123","name":"Product","code":"PROD-001"}]}}
```
Tokens:
Raw