> ## Documentation Index
> Fetch the complete documentation index at: https://help.commbox.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Returns a WhatsApp ID for an uploaded file

> This API returns the name of an uploaded file (doc/image/video) and the generated ID for it. The ID can then be used in any requests to retrieve the media stored in the WhatsApp Business API client.

## OpenAPI

````json POST /whatsapp/uploadmedia/{ENCRYPTED_STREAM_ID}
{
  "openapi": "3.0.3",
  "info": {
    "title": "CommBox API",
    "x-logo": {
      "url": "https://www.commbox.io/logo/commbox_logo_large.png"
    },
    "version": "2.07",
    "termsOfService": "https://www.commbox.io/end-user-license-agreement-eula/",
    "contact": {
      "name": "commbox",
      "url": "https://www.commbox.io",
      "email": "contactus@commbox.io"
    }
  },
  "servers": [
    {
      "url": "https://api.commbox.io/",
      "description": "Production server"
    }
  ],
  "paths": {
    "/whatsapp/uploadmedia/{ENCRYPTED_STREAM_ID}": {
      "post": {
        "tags": [
          "WhatsApp"
        ],
        "summary": "Returns a WhatsApp ID for an uploaded file",
        "description": "This API returns the name of an uploaded file (doc/image/video) and the generated ID for it. The ID can then be used in any requests to retrieve the media stored in the WhatsApp Business API client.",
        "operationId": "Upload_A_File_And_Get_Id_For_Uploaded_File",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "pic": {
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "ENCRYPTED_STREAM_ID",
            "in": "path",
            "description": "CommBox generated encryption for the channel",
            "required": true,
            "schema": {
              "$ref": "#/components/parameters/ENCRYPTED_STREAM_ID/schema"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": 200
                    },
                    "description": {
                      "type": "string",
                      "example": "Operation successful"
                    },
                    "response_time": {
                      "type": "string",
                      "example": "2024-08-06T07:51:52.2581942Z"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "filename": {
                            "type": "string",
                            "example": "video_sample.mp4"
                          },
                          "id": {
                            "type": "string",
                            "example": "257250616863050"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request, could not process the input data",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "status": "400",
                  "description": "Missing parameter templateName",
                  "response_time": "2024-08-06T07:51:52.2581942Z",
                  "data": [
                    {
                      "recipient": "9725551234",
                      "status": 400,
                      "failed": "Missing required parameter"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized - The supplied credentials, if any, are not sufficient to access the resource",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "example": 401
                    },
                    "description": {
                      "type": "string",
                      "example": "Unauthorized"
                    },
                    "response_time": {
                      "type": "string",
                      "format": "date-time",
                      "example": "2025-02-06T07:51:52.2581942Z"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found - The requested resource is not found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "example": 404
                    },
                    "description": {
                      "type": "string",
                      "example": "Not Found"
                    },
                    "response_time": {
                      "type": "string",
                      "format": "date-time",
                      "example": "2025-02-06T07:51:52.2581942Z"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests - Too many requests have been made in a short period of time (Throttling)",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "example": 429
                    },
                    "description": {
                      "type": "string",
                      "example": "Too Many Requests"
                    },
                    "response_time": {
                      "type": "string",
                      "format": "date-time",
                      "example": "2025-02-06T07:51:52.2581942Z"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Server Error - The server could not return the representation due to an internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "example": 500
                    },
                    "description": {
                      "type": "string",
                      "example": "Internal Server Error"
                    },
                    "response_time": {
                      "type": "string",
                      "format": "date-time",
                      "example": "2025-02-06T07:51:52.2581942Z"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "description": "Error status code as string",
            "example": "400"
          },
          "description": {
            "type": "string",
            "description": "Human-readable description of the error",
            "example": "Missing parameter templateName"
          },
          "response_time": {
            "type": "string",
            "description": "Timestamp of the response",
            "example": "2024-08-06T07:51:52.2581942Z"
          },
          "data": {
            "type": "array",
            "description": "Array of recipient error details",
            "items": {
              "type": "object",
              "properties": {
                "recipient": {
                  "type": "string",
                  "description": "Recipient's phone number",
                  "example": "9725551234"
                },
                "status": {
                  "type": "integer",
                  "description": "Error status code",
                  "example": 400
                },
                "failed": {
                  "type": "string",
                  "description": "Failure reason",
                  "example": "Missing required parameter"
                }
              }
            }
          }
        },
        "required": [
          "status",
          "description",
          "response_time"
        ]
      }
    }
  }
}
````